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.
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. |
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
void matchRuledCanonicalUnitId(Id canonicalUnitId, boolean match)
canonicalUnitId
- the canonical unit Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- canonicalUnitId
is null
mandatory
- This method must be implemented. void clearRuledCanonicalUnitIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledCanonicalUnitQuery()
CanonicalUnitQuery
is available. true
if a canonical unit query is available,
false
otherwisemandatory
- This method must be implemented. CanonicalUnitQuery getRuledCanonicalUnitQuery()
OR
term.UnimplementedException
-
supportsRuledCanonicalUnitQuery()
is false
optional
- This method must be implemented if
supportsRuledCanonicalUnitQuery()
is true.
void matchAnyRuledCanonicalUnit(boolean match)
match
- true
for mapped to any canonical unit,
false
to match mapped to no canonicalUnitmandatory
- This method must be implemented. void clearRuledCanonicalUnitTerms()
mandatory
- This method must be implemented. void matchCatalogueId(Id catalogueId, boolean match)
catalogueId
- the catalogue Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- catalogueId
is
null
mandatory
- This method must be implemented. void clearCatalogueIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsCatalogueQuery()
CatalogueQuery
is available. true
if a catalogue query is available,
false
otherwisemandatory
- This method must be implemented. CatalogueQuery getCatalogueQuery()
OR
term.UnimplementedException
-
supportsCatalogueQuery()
is false
optional
- This method must be implemented if
supportsCatalogueQuery()
is true.
void clearCatalogueTerms()
mandatory
- This method must be implemented. CanonicalUnitProcessorQueryRecord getCanonicalUnitProcessorQueryRecord(Type canonicalUnitProcessorRecordType) throws OperationFailedException
CanonicalUnitProcessor
record Type.
Multiple record retrievals produce a nested OR
term.canonicalUnitProcessorRecordType
- a canonical unit processor
record typeNullArgumentException
-
canonicalUnitProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(canonicalUnitProcessorRecordType)
is
false
mandatory
- This method must be implemented.