org.osid.control

Interface InputQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

Methods inherited from interface org.osid.OsidObjectQuery

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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Method Detail

matchDeviceId

void matchDeviceId(Id deviceId,
                 boolean match)

Sets the device Id for this query.

Parameters:

deviceId - the device Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - deviceId is null

Compliance:

mandatory - This method must be implemented.

clearDeviceIdTerms

void clearDeviceIdTerms()

Clears the device Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDeviceQuery

boolean supportsDeviceQuery()

Tests if a DeviceQuery is available.

Returns:

true if a device query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDeviceQuery

DeviceQuery getDeviceQuery()

Gets the query for a device. Multiple retrievals produce a nested OR term.

Returns:

the device query

Throws:

UnimplementedException - supportsDeviceQuery() is false

Compliance:

optional - This method must be implemented if supportsDeviceQuery() is true.

clearDeviceTerms

void clearDeviceTerms()

Clears the device query terms.

Compliance:

mandatory - This method must be implemented.

matchControllerId

void matchControllerId(Id controllerId,
                     boolean match)

Sets the controller Id for this query.

Parameters:

controllerId - the controller Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - controllerId is null

Compliance:

mandatory - This method must be implemented.

clearControllerIdTerms

void clearControllerIdTerms()

Clears the controller Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsControllerQuery

boolean supportsControllerQuery()

Tests if a ControllerQuery is available.

Returns:

true if a controller query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getControllerQuery

ControllerQuery getControllerQuery()

Gets the query for a ControllerQuery. Multiple retrievals produce a nested OR term.

Returns:

the controller query

Throws:

UnimplementedException - supportsControllerQuery() is false

Compliance:

optional - This method must be implemented if supportsControllerQuery() is true.

clearControllerTerms

void clearControllerTerms()

Clears the controller query terms.

Compliance:

mandatory - This method must be implemented.

matchSystemId

void matchSystemId(Id systemId,
                 boolean match)

Sets the system Id for this query to match inputs assigned to systems.

Parameters:

systemId - the system Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - sustemId is null

Compliance:

mandatory - This method must be implemented.

clearSystemIdTerms

void clearSystemIdTerms()

Clears the system Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsSystemQuery

boolean supportsSystemQuery()

Tests if a SystemQuery is available.

Returns:

true if a system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSystemQuery

SystemQuery getSystemQuery()

Gets the query for a system. Multiple retrievals produce a nested OR term.

Returns:

the system query

Throws:

UnimplementedException - supportsSystemQuery() is false

Compliance:

optional - This method must be implemented if supportsSystemQuery() is true.

clearSystemTerms

void clearSystemTerms()

Clears the system query terms.

Compliance:

mandatory - This method must be implemented.

getInputQueryRecord

InputQueryRecord getInputQueryRecord(Type inputRecordType)
                                     throws OperationFailedException

Gets the input query record corresponding to the given Input record Type. Multiple record retrievals produce a nested OR term.

Parameters:

inputRecordType - an input record type

Returns:

the input query record

Throws:

NullArgumentException - inputRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inputRecordType) is false

Compliance:

mandatory - This method must be implemented.