org.osid.control

Interface SceneQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface SceneQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining scene queries.

Method Summary

Methods

Modifier and Type	Method and Description
SceneQueryInspectorRecord	getSceneQueryInspectorRecord(Type sceneRecordType) Gets the scene query inspector record corresponding to the given Scene record Type.
IdTerm[]	getSettingIdTerms() Gets the setting Id query terms.
SettingQueryInspector[]	getSettingTerms() Gets the setting query terms.
IdTerm[]	getSystemIdTerms() Gets the system Id query terms.
SystemQueryInspector[]	getSystemTerms() Gets the system 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

Method Detail

getSettingIdTerms

IdTerm[] getSettingIdTerms()

Gets the setting Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSettingTerms

SettingQueryInspector[] getSettingTerms()

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

getSceneQueryInspectorRecord

SceneQueryInspectorRecord getSceneQueryInspectorRecord(Type sceneRecordType)
                                                       throws OperationFailedException

Gets the scene query inspector record corresponding to the given Scene record Type.

Parameters:

sceneRecordType - a scene record type

Returns:

the scene query inspector record

Throws:

NullArgumentException - sceneRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(sceneRecordType) is false

Compliance:

mandatory - This method must be implemented.