org.osid.control

Interface InputQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector

public interface InputQueryInspector
extends OsidRuleQueryInspector

This is the query inspector for examining input queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getControllerIdTerms() Gets the controller Id query terms.
ControllerQueryInspector[]	getControllerTerms() Gets the controller query terms.
IdTerm[]	getDeviceIdTerms() Gets the device Id query terms.
DeviceQueryInspector[]	getDeviceTerms() Gets the device query terms.
InputQueryInspectorRecord	getInputQueryInspectorRecord(Type inputRecordType) Gets the input query inspector record corresponding to the given Input record Type.
IdTerm[]	getSystemIdTerms() Gets the system Id query terms.
SystemQueryInspector[]	getSystemTerms() Gets the system query terms.

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Method Detail

getDeviceIdTerms

IdTerm[] getDeviceIdTerms()

Gets the device Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDeviceTerms

DeviceQueryInspector[] getDeviceTerms()

Gets the device query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getControllerIdTerms

IdTerm[] getControllerIdTerms()

Gets the controller Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getControllerTerms

ControllerQueryInspector[] getControllerTerms()

Gets the controller query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSystemIdTerms

IdTerm[] getSystemIdTerms()

Gets the system Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSystemTerms

SystemQueryInspector[] getSystemTerms()

Gets the system query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInputQueryInspectorRecord

InputQueryInspectorRecord getInputQueryInspectorRecord(Type inputRecordType)
                                                       throws OperationFailedException

Gets the input query inspector record corresponding to the given Input record Type.

Parameters:

inputRecordType - an input record type

Returns:

the input query inspector record

Throws:

NullArgumentException - inputRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inputRecordType) is false

Compliance:

mandatory - This method must be implemented.