org.osid.offering.rules

Interface CanonicalUnitProcessorQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidProcessorQuery, OsidQuery, OsidRuleQuery, Suppliable

public interface CanonicalUnitProcessorQuery
extends OsidProcessorQuery

This is the query for searching canonical unit processors. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCatalogueIdTerms() Clears the catalogue Id query terms.
void	clearCatalogueTerms() Clears the catalogue query terms.
void	clearRuledCanonicalUnitIdTerms() Clears the canonical unit Id query terms.
void	clearRuledCanonicalUnitTerms() Clears the canonical unit query terms.
CanonicalUnitProcessorQueryRecord	getCanonicalUnitProcessorQueryRecord(Type canonicalUnitProcessorRecordType) Gets the canonical unit processor query record corresponding to the given CanonicalUnitProcessor record Type.
CatalogueQuery	getCatalogueQuery() Gets the query for a catalogue.
CanonicalUnitQuery	getRuledCanonicalUnitQuery() Gets the query for a canonical unit.
void	matchAnyRuledCanonicalUnit(boolean match) Matches mapped to any canonical unit.
void	matchCatalogueId(Id catalogueId, boolean match) Matches mapped to the catalogue.
void	matchRuledCanonicalUnitId(Id canonicalUnitId, boolean match) Matches mapped to the canonical unit.
boolean	supportsCatalogueQuery() Tests if a CatalogueQuery is available.
boolean	supportsRuledCanonicalUnitQuery() Tests if a CanonicalUnitQuery is available.

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Method Detail

matchRuledCanonicalUnitId

void matchRuledCanonicalUnitId(Id canonicalUnitId,
                             boolean match)

Matches mapped to the canonical unit.

Parameters:

canonicalUnitId - the canonical unit Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - canonicalUnitId is null

Compliance:

mandatory - This method must be implemented.

clearRuledCanonicalUnitIdTerms

void clearRuledCanonicalUnitIdTerms()

Clears the canonical unit Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledCanonicalUnitQuery

boolean supportsRuledCanonicalUnitQuery()

Tests if a CanonicalUnitQuery is available.

Returns:

true if a canonical unit query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledCanonicalUnitQuery

CanonicalUnitQuery getRuledCanonicalUnitQuery()

Gets the query for a canonical unit. Multiple retrievals produce a nested OR term.

Returns:

the canonical unit query

Throws:

UnimplementedException - supportsRuledCanonicalUnitQuery() is false

Compliance:

optional - This method must be implemented if supportsRuledCanonicalUnitQuery() is true.

matchAnyRuledCanonicalUnit

void matchAnyRuledCanonicalUnit(boolean match)

Matches mapped to any canonical unit.

Parameters:

match - true for mapped to any canonical unit, false to match mapped to no canonicalUnit

Compliance:

mandatory - This method must be implemented.

clearRuledCanonicalUnitTerms

void clearRuledCanonicalUnitTerms()

Clears the canonical unit query terms.

Compliance:

mandatory - This method must be implemented.

matchCatalogueId

void matchCatalogueId(Id catalogueId,
                    boolean match)

Matches mapped to the catalogue.

Parameters:

catalogueId - the catalogue Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - catalogueId is null

Compliance:

mandatory - This method must be implemented.

clearCatalogueIdTerms

void clearCatalogueIdTerms()

Clears the catalogue Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsCatalogueQuery

boolean supportsCatalogueQuery()

Tests if a CatalogueQuery is available.

Returns:

true if a catalogue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCatalogueQuery

CatalogueQuery getCatalogueQuery()

Gets the query for a catalogue. Multiple retrievals produce a nested OR term.

Returns:

the catalogue query

Throws:

UnimplementedException - supportsCatalogueQuery() is false

Compliance:

optional - This method must be implemented if supportsCatalogueQuery() is true.

clearCatalogueTerms

void clearCatalogueTerms()

Clears the catalogue query terms.

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorQueryRecord

CanonicalUnitProcessorQueryRecord getCanonicalUnitProcessorQueryRecord(Type canonicalUnitProcessorRecordType)
                                                                       throws OperationFailedException

Gets the canonical unit processor query record corresponding to the given CanonicalUnitProcessor record Type. Multiple record retrievals produce a nested OR term.

Parameters:

canonicalUnitProcessorRecordType - a canonical unit processor record type

Returns:

the canonical unit processor query record

Throws:

NullArgumentException - canonicalUnitProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.