public interface InputEnablerQuery extends OsidEnablerQuery
This is the query for searching input 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 |
clearRuledInputIdTerms()
Clears the input
Id query terms. |
void |
clearRuledInputTerms()
Clears the input query terms.
|
void |
clearSystemIdTerms()
Clears the system
Id query terms. |
void |
clearSystemTerms()
Clears the system query terms.
|
InputEnablerQueryRecord |
getInputEnablerQueryRecord(Type inputEnablerRecordType)
Gets the input enabler query record corresponding to the given
InputEnabler record Type. |
InputQuery |
getRuledInputQuery()
Gets the query for an input.
|
SystemQuery |
getSystemQuery()
Gets the query for a system.
|
void |
matchAnyRuledInput(boolean match)
Matches enablers mapped to any input.
|
void |
matchRuledInputId(Id inputId,
boolean match)
Matches enablers mapped to the input.
|
void |
matchSystemId(Id systemId,
boolean match)
Matches enablers mapped to the system.
|
boolean |
supportsRuledInputQuery()
Tests if an
InputQuery 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 matchRuledInputId(Id inputId, boolean match)
inputId
- the device Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- inputId
is
null
mandatory
- This method must be implemented. void clearRuledInputIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledInputQuery()
InputQuery
is available. true
if an input query is available,
false
otherwisemandatory
- This method must be implemented. InputQuery getRuledInputQuery()
OR
term.UnimplementedException
-
supportsRuledInputQuery()
is false
optional
- This method must be implemented if
supportsRuledInputQuery()
is true.
void matchAnyRuledInput(boolean match)
match
- true
for enablers mapped to any input,
false
to match enablers mapped to no inputsmandatory
- This method must be implemented. void clearRuledInputTerms()
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. InputEnablerQueryRecord getInputEnablerQueryRecord(Type inputEnablerRecordType) throws OperationFailedException
InputEnabler
record Type.
Multiple record
retrievals produce a nested OR
term.inputEnablerRecordType
- an input enabler record typeNullArgumentException
- inputEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inputEnablerRecordType)
is false
mandatory
- This method must be implemented.