org.osid.control

Interface ActionQueryInspector

All Superinterfaces:

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

public interface ActionQueryInspector
extends OsidRuleQueryInspector, OsidSubjugateableQueryInspector

This is the query inspector for examining action queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getActionGroupIdTerms() Gets the action group Id query terms.
ActionGroupQueryInspector[]	getActionGroupTerms() Gets the action group query terms.
ActionQueryInspectorRecord	getActionQueryInspectorRecord(Type actionRecordType) Gets the action query inspector record corresponding to the given Action record Type.
BooleanTerm[]	getBlockingTerms() Gets the blocking query terms.
DurationRangeTerm[]	getDelayTerms() Gets the delay query terms.
IdTerm[]	getNextActionGroupIdTerms() Gets the action group Id query terms.
ActionGroupQueryInspector[]	getNextActionGroupTerms() Gets the action group query terms.
IdTerm[]	getSceneIdTerms() Gets the scene Id query terms.
SceneQueryInspector[]	getSceneTerms() Gets the scene query terms.
IdTerm[]	getSettingIdTerms() Gets the setting Id query terms.
SettingQueryInspector[]	getSettingTerms() Gets the setting 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

getActionGroupIdTerms

IdTerm[] getActionGroupIdTerms()

Gets the action group Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getActionGroupTerms

ActionGroupQueryInspector[] getActionGroupTerms()

Gets the action group query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDelayTerms

DurationRangeTerm[] getDelayTerms()

Gets the delay query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBlockingTerms

BooleanTerm[] getBlockingTerms()

Gets the blocking query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getNextActionGroupIdTerms

IdTerm[] getNextActionGroupIdTerms()

Gets the action group Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getNextActionGroupTerms

ActionGroupQueryInspector[] getNextActionGroupTerms()

Gets the action group query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSceneIdTerms

IdTerm[] getSceneIdTerms()

Gets the scene Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSceneTerms

SceneQueryInspector[] getSceneTerms()

Gets the scene query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

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.

getActionQueryInspectorRecord

ActionQueryInspectorRecord getActionQueryInspectorRecord(Type actionRecordType)
                                                         throws OperationFailedException

Gets the action query inspector record corresponding to the given Action record Type.

Parameters:

actionRecordType - an action record type

Returns:

the action query inspector record

Throws:

NullArgumentException - actionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(actionRecordType) is false

Compliance:

mandatory - This method must be implemented.