org.osid.control

Interface ControllerQueryInspector

All Superinterfaces:

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

public interface ControllerQueryInspector
extends OsidObjectQueryInspector, OsidOperableQueryInspector

This is the query inspector for examning controller queries.

Method Summary

Methods

Modifier and Type	Method and Description
StringTerm[]	getAddressTerms() Gets the address query terms.
ControllerQueryInspectorRecord	getControllerQueryInspectorRecord(Type controllerRecordType) Gets the controller query inspector record corresponding to the given Controller record Type.
IdTerm[]	getDiscreetStateIdTerms() Gets the state Id query terms.
BooleanTerm[]	getDiscreetStatesTerms() Gets the discreet query terms.
StateQueryInspector[]	getDiscreetStateTerms() Gets the state query terms.
IdTerm[]	getModelIdTerms() Gets the model Id query terms.
ModelQueryInspector[]	getModelTerms() Gets the model query terms.
IdTerm[]	getSystemIdTerms() Gets the system Id query terms.
SystemQueryInspector[]	getSystemTerms() Gets the system query terms.
BooleanTerm[]	getToggleableTerms() Gets the toggle query terms.
BooleanTerm[]	getVariableByPercentageTerms() Gets the variable percentage query terms.
DecimalRangeTerm[]	getVariableMaximumTerms() Gets the variable maximum query terms.
DecimalRangeTerm[]	getVariableMinimumTerms() Gets the variable minimum query terms.
BooleanTerm[]	getVariableTerms() Gets the variable query terms.
VersionTerm[]	getVersionSinceTerms() Gets the version since query terms.
VersionTerm[]	getVersionTerms() Gets the version query terms.

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

getAddressTerms

StringTerm[] getAddressTerms()

Gets the address query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getModelIdTerms

IdTerm[] getModelIdTerms()

Gets the model Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getModelTerms

ModelQueryInspector[] getModelTerms()

Gets the model query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVersionTerms

VersionTerm[] getVersionTerms()

Gets the version query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVersionSinceTerms

VersionTerm[] getVersionSinceTerms()

Gets the version since query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getToggleableTerms

BooleanTerm[] getToggleableTerms()

Gets the toggle query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVariableTerms

BooleanTerm[] getVariableTerms()

Gets the variable query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVariableByPercentageTerms

BooleanTerm[] getVariableByPercentageTerms()

Gets the variable percentage query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVariableMinimumTerms

DecimalRangeTerm[] getVariableMinimumTerms()

Gets the variable minimum query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVariableMaximumTerms

DecimalRangeTerm[] getVariableMaximumTerms()

Gets the variable maximum query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDiscreetStatesTerms

BooleanTerm[] getDiscreetStatesTerms()

Gets the discreet query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDiscreetStateIdTerms

IdTerm[] getDiscreetStateIdTerms()

Gets the state Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDiscreetStateTerms

StateQueryInspector[] getDiscreetStateTerms()

Gets the state 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.

getControllerQueryInspectorRecord

ControllerQueryInspectorRecord getControllerQueryInspectorRecord(Type controllerRecordType)
                                                                 throws OperationFailedException

Gets the controller query inspector record corresponding to the given Controller record Type.

Parameters:

controllerRecordType - a controller record type

Returns:

the controller query inspector record

Throws:

NullArgumentException - controllerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(controllerRecordType) is false

Compliance:

mandatory - This method must be implemented.