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
Modifier and TypeMethodDescriptionIdTerm[]Gets the action groupIdquery terms.Gets the action group query terms.getActionQueryInspectorRecord(Type actionRecordType) Gets the action query inspector record corresponding to the givenActionrecordType.Gets the blocking query terms.Gets the delay query terms.IdTerm[]Gets the action groupIdquery terms.Gets the action group query terms.IdTerm[]Gets the sceneIdquery terms.Gets the scene query terms.IdTerm[]Gets the settingIdquery terms.Gets the setting query terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidOperableQueryInspector
getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTermsModifier and TypeMethodDescriptionGets the active query terms.Gets the administratively disabled query terms.Gets the administratively enabled query terms.Gets the operational query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.Methods inherited from interface OsidRuleQueryInspector
getConditionRecordTypeTerms, getRuleIdTerms, getRuleTerms
-
Method Details
-
getActionGroupIdTerms
IdTerm[] getActionGroupIdTerms()Gets the action groupIdquery 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 groupIdquery 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 sceneIdquery 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 settingIdquery 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 givenActionrecordType.- Parameters:
actionRecordType- an action record type- Returns:
- the action query inspector record
- Throws:
NullArgumentException-actionRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(actionRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-