public interface CanonicalUnitProcessorEnablerQuery extends OsidEnablerQuery
This is the query for searching canonical unit processor enablers. 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 |
clearRuledCanonicalUnitProcessorIdTerms()
Clears the canonical unit processor
Id query terms. |
void |
clearRuledCanonicalUnitProcessorTerms()
Clears the canonical unit processor query terms.
|
CanonicalUnitProcessorEnablerQueryRecord |
getCanonicalUnitProcessorEnablerQueryRecord(Type canonicalUnitProcessorEnablerRecordType)
Gets the canonical unit processor enabler query record corresponding
to the given
CanonicalUnitProcessorEnabler record
Type. |
CatalogueQuery |
getCatalogueQuery()
Gets the query for a catalogue.
|
CanonicalUnitProcessorQuery |
getRuledCanonicalUnitProcessorQuery()
Gets the query for a canonical unit processor.
|
void |
matchAnyRuledCanonicalUnitProcessor(boolean match)
Matches enablers mapped to any canonical unit processor.
|
void |
matchCatalogueId(Id catalogueId,
boolean match)
Matches enablers mapped to the catalogue.
|
void |
matchRuledCanonicalUnitProcessorId(Id canonicalUnitProcessorId,
boolean match)
Matches enablers mapped to the canonical unit processor.
|
boolean |
supportsCatalogueQuery()
Tests if a
CatalogueQuery is available. |
boolean |
supportsRuledCanonicalUnitProcessorQuery()
Tests if a
CanonicalUnitProcessorQuery is available. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRuledCanonicalUnitProcessorId(Id canonicalUnitProcessorId, boolean match)
canonicalUnitProcessorId
- the canonical unit Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- canonicalUnitProcessorId
is null
mandatory
- This method must be implemented. void clearRuledCanonicalUnitProcessorIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledCanonicalUnitProcessorQuery()
CanonicalUnitProcessorQuery
is available. true
if a canonical unit processor query is
available, false
otherwisemandatory
- This method must be implemented. CanonicalUnitProcessorQuery getRuledCanonicalUnitProcessorQuery()
OR
term.UnimplementedException
-
supportsRuledCanonicalUnitProcessorQuery()
is
false
optional
- This method must be implemented if
supportsRuledCanonicalUnitProcessorQuery()
is
true.
void matchAnyRuledCanonicalUnitProcessor(boolean match)
match
- true
for enablers mapped to any canonical
unit processor, false
to match enablers mapped
to no canonical unit processorsmandatory
- This method must be implemented. void clearRuledCanonicalUnitProcessorTerms()
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. CanonicalUnitProcessorEnablerQueryRecord getCanonicalUnitProcessorEnablerQueryRecord(Type canonicalUnitProcessorEnablerRecordType) throws OperationFailedException
CanonicalUnitProcessorEnabler
record
Type.
Multiple record retrievals produce a nested
OR
term.canonicalUnitProcessorEnablerRecordType
- a canonical unit
processor enabler record typeNullArgumentException
-
canonicalUnitProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(canonicalUnitProcessorEnablerRecordType)
is false
mandatory
- This method must be implemented.