public interface ActionEnablerQuery extends OsidEnablerQuery
This is the query for searching action 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 |
clearRuledActionIdTerms()
Clears the action
Id query terms. |
void |
clearRuledActionTerms()
Clears the action query terms.
|
void |
clearSystemIdTerms()
Clears the system
Id query terms. |
void |
clearSystemTerms()
Clears the system query terms.
|
ActionEnablerQueryRecord |
getActionEnablerQueryRecord(Type actionEnablerRecordType)
Gets the action enabler query record corresponding to the given
ActionEnabler record Type. |
ActionQuery |
getRuledActionQuery()
Gets the query for an action.
|
SystemQuery |
getSystemQuery()
Gets the query for a system.
|
void |
matchAnyRuledAction(boolean match)
Matches enablers mapped to any action.
|
void |
matchRuledActionId(Id actionId,
boolean match)
Matches enablers mapped to the action.
|
void |
matchSystemId(Id systemId,
boolean match)
Matches enablers mapped to the system.
|
boolean |
supportsRuledActionQuery()
Tests if an
ActionQuery is available. |
boolean |
supportsSystemQuery()
Tests if a
SystemQuery 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 matchRuledActionId(Id actionId, boolean match)
actionId
- the action Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- actionId
is
null
mandatory
- This method must be implemented. void clearRuledActionIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledActionQuery()
ActionQuery
is available. true
if an action query is available,
false
otherwisemandatory
- This method must be implemented. ActionQuery getRuledActionQuery()
OR
term.UnimplementedException
-
supportsRuledActionQuery()
is false
optional
- This method must be implemented if
supportsRuledActionQuery()
is true.
void matchAnyRuledAction(boolean match)
match
- true
for enablers mapped to any action,
false
to match enablers mapped to no actionsmandatory
- This method must be implemented. void clearRuledActionTerms()
mandatory
- This method must be implemented. void matchSystemId(Id systemId, boolean match)
systemId
- the system Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- systemId
is
null
mandatory
- This method must be implemented. void clearSystemIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsSystemQuery()
SystemQuery
is available. true
if a system query is available,
false
otherwisemandatory
- This method must be implemented. SystemQuery getSystemQuery()
OR
term.UnimplementedException
- supportsSystemQuery()
is false
optional
- This method must be implemented if
supportsSystemQuery()
is true.
void clearSystemTerms()
mandatory
- This method must be implemented. ActionEnablerQueryRecord getActionEnablerQueryRecord(Type actionEnablerRecordType) throws OperationFailedException
ActionEnabler
record Type.
Multiple record
retrievals produce a nested OR
term.actionEnablerRecordType
- an action enabler record typeNullArgumentException
- actionEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(actionEnablerRecordType)
is false
mandatory
- This method must be implemented.