public interface DeviceEnablerQuery extends OsidEnablerQuery
This is the query for searching device 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 |
clearRuledTriggerIdTerms()
Clears the trigger
Id query terms. |
void |
clearRuledTriggerTerms()
Clears the trigger query terms.
|
void |
clearSystemIdTerms()
Clears the system
Id query terms. |
void |
clearSystemTerms()
Clears the system query terms.
|
DeviceEnablerQueryRecord |
getDeviceEnablerQueryRecord(Type deviceEnablerRecordType)
Gets the device enabler query record corresponding to the given
DeviceEnabler record Type. |
TriggerQuery |
getRuledTriggerQuery()
Gets the query for an trigger.
|
SystemQuery |
getSystemQuery()
Gets the query for a system.
|
void |
matchAnyRuledTrigger(boolean match)
Matches enablers mapped to any trigger.
|
void |
matchRuledTriggerId(Id triggerId,
boolean match)
Matches enablers mapped to the trigger.
|
void |
matchSystemId(Id systemId,
boolean match)
Matches enablers mapped to the system.
|
boolean |
supportsRuledTriggerQuery()
Tests if an
TriggerQuery 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 matchRuledTriggerId(Id triggerId, boolean match)
triggerId
- the trigger Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- triggerId
is
null
mandatory
- This method must be implemented. void clearRuledTriggerIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledTriggerQuery()
TriggerQuery
is available. true
if an trigger query is available,
false
otherwisemandatory
- This method must be implemented. TriggerQuery getRuledTriggerQuery()
OR
term.UnimplementedException
-
supportsRuledTriggerQuery()
is false
optional
- This method must be implemented if
supportsRuledTriggerQuery()
is true.
void matchAnyRuledTrigger(boolean match)
match
- true
for enablers mapped to any trigger,
false
to match enablers mapped to no triggersmandatory
- This method must be implemented. void clearRuledTriggerTerms()
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. DeviceEnablerQueryRecord getDeviceEnablerQueryRecord(Type deviceEnablerRecordType) throws OperationFailedException
DeviceEnabler
record Type.
Multiple record
retrievals produce a nested OR
term.deviceEnablerRecordType
- a device enabler record typeNullArgumentException
- deviceEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(deviceEnablerRecordType)
is false
mandatory
- This method must be implemented.