public interface InputQuery extends OsidRuleQuery
This is the query for searching inputs. 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 |
clearControllerIdTerms()
Clears the controller
Id query terms. |
void |
clearControllerTerms()
Clears the controller query terms.
|
void |
clearDeviceIdTerms()
Clears the device
Id query terms. |
void |
clearDeviceTerms()
Clears the device query terms.
|
void |
clearSystemIdTerms()
Clears the system
Id query terms. |
void |
clearSystemTerms()
Clears the system query terms.
|
ControllerQuery |
getControllerQuery()
Gets the query for a
ControllerQuery. |
DeviceQuery |
getDeviceQuery()
Gets the query for a device.
|
InputQueryRecord |
getInputQueryRecord(Type inputRecordType)
Gets the input query record corresponding to the given
Input
record Type. |
SystemQuery |
getSystemQuery()
Gets the query for a system.
|
void |
matchControllerId(Id controllerId,
boolean match)
Sets the controller
Id for this query. |
void |
matchDeviceId(Id deviceId,
boolean match)
Sets the device
Id for this query. |
void |
matchSystemId(Id systemId,
boolean match)
Sets the system
Id for this query to match inputs
assigned to systems. |
boolean |
supportsControllerQuery()
Tests if a
ControllerQuery is available. |
boolean |
supportsDeviceQuery()
Tests if a
DeviceQuery is available. |
boolean |
supportsSystemQuery()
Tests if a
SystemQuery is available. |
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
void matchDeviceId(Id deviceId, boolean match)
Id
for this query.deviceId
- the device Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- deviceId
is
null
mandatory
- This method must be implemented. void clearDeviceIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDeviceQuery()
DeviceQuery
is available. true
if a device query is available,
false
otherwisemandatory
- This method must be implemented. DeviceQuery getDeviceQuery()
OR
term.UnimplementedException
- supportsDeviceQuery()
is false
optional
- This method must be implemented if
supportsDeviceQuery()
is true.
void clearDeviceTerms()
mandatory
- This method must be implemented. void matchControllerId(Id controllerId, boolean match)
Id
for this query.controllerId
- the controller Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- controllerId
is
null
mandatory
- This method must be implemented. void clearControllerIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsControllerQuery()
ControllerQuery
is available. true
if a controller query is available,
false
otherwisemandatory
- This method must be implemented. ControllerQuery getControllerQuery()
ControllerQuery.
Multiple
retrievals produce a nested OR
term.UnimplementedException
-
supportsControllerQuery()
is false
optional
- This method must be implemented if
supportsControllerQuery()
is true.
void clearControllerTerms()
mandatory
- This method must be implemented. void matchSystemId(Id systemId, boolean match)
Id
for this query to match inputs
assigned to systems.systemId
- the system Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- sustemId
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. InputQueryRecord getInputQueryRecord(Type inputRecordType) throws OperationFailedException
Input
record Type.
Multiple record retrievals produce
a nested OR
term.inputRecordType
- an input record typeNullArgumentException
- inputRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inputRecordType)
is false
mandatory
- This method must be implemented.