public interface CompositionEnablerQuery extends OsidEnablerQuery
This is the query for searching composition 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 |
clearRepositoryIdTerms()
Clears the repository
Id query terms. |
void |
clearRepositoryTerms()
Clears the repository query terms.
|
void |
clearRuledCompositionIdTerms()
Clears the composition
Id query terms. |
void |
clearRuledCompositionTerms()
Clears the composition query terms.
|
CompositionEnablerQueryRecord |
getCompositionEnablerQueryRecord(Type compositionEnablerRecordType)
Gets the composition enabler query record corresponding to the given
CompositionEnabler record Type. |
RepositoryQuery |
getRepositoryQuery()
Gets the query for a repository.
|
CompositionQuery |
getRuledCompositionQuery()
Gets the query for a composition.
|
void |
matchAnyRuledComposition(boolean match)
Matches enablers mapped to any composition.
|
void |
matchRepositoryId(Id repositoryId,
boolean match)
Matches enablers mapped to the composition.
|
void |
matchRuledCompositionId(Id compositionId,
boolean match)
Matches enablers mapped to the composition.
|
boolean |
supportsRepositoryQuery()
Tests if a
RepositoryQuery is available. |
boolean |
supportsRuledCompositionQuery()
Tests if a
CompositionQuery 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 matchRuledCompositionId(Id compositionId, boolean match)
compositionId
- the composition Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- compositionId
is
null
mandatory
- This method must be implemented. void clearRuledCompositionIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledCompositionQuery()
CompositionQuery
is available. true
if a composition query is available,
false
otherwisemandatory
- This method must be implemented. CompositionQuery getRuledCompositionQuery()
OR
term.UnimplementedException
-
supportsRuledCompositionQuery()
is false
optional
- This method must be implemented if
supportsRuledCompositionQuery()
is true.
void matchAnyRuledComposition(boolean match)
match
- true
for enablers mapped to any
composition, false
to match enablers mapped to
no compositionmandatory
- This method must be implemented. void clearRuledCompositionTerms()
mandatory
- This method must be implemented. void matchRepositoryId(Id repositoryId, boolean match)
repositoryId
- the repository Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- repositoryId
is
null
mandatory
- This method must be implemented. void clearRepositoryIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRepositoryQuery()
RepositoryQuery
is available. true
if a repository query is available,
false
otherwisemandatory
- This method must be implemented. RepositoryQuery getRepositoryQuery()
OR
term.UnimplementedException
-
supportsRepositoryQuery()
is false
optional
- This method must be implemented if
supportsRepositoryQuery()
is true.
void clearRepositoryTerms()
mandatory
- This method must be implemented. CompositionEnablerQueryRecord getCompositionEnablerQueryRecord(Type compositionEnablerRecordType) throws OperationFailedException
CompositionEnabler
record Type.
Multiple
record retrievals produce a nested OR
term.compositionEnablerRecordType
- a composition enabler record typeNullArgumentException
-
compositionEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(compositionEnablerRecordType)
is
false
mandatory
- This method must be implemented.