OSID Specifications
control package
Version 3.1.0
control package
Version 3.1.0
| Interface | osid.control.ActionQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRuleQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| Used By | osid.control.ActionGroupQueryInspector | ||
osid.control.rules.ActionEnablerQueryInspector | |||
| Description |
This is the query inspector for examining action queries. | ||
| Method | getActionGroupIdTerms | ||
| Description |
Gets the action group | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActionGroupTerms | ||
| Description |
Gets the action group query terms. | ||
| Return | osid.control.ActionGroupQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDelayTerms | ||
| Description |
Gets the delay query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBlockingTerms | ||
| Description |
Gets the blocking query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextActionGroupIdTerms | ||
| Description |
Gets the action group | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextActionGroupTerms | ||
| Description |
Gets the action group query terms. | ||
| Return | osid.control.ActionGroupQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSceneIdTerms | ||
| Description |
Gets the scene | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSceneTerms | ||
| Description |
Gets the scene query terms. | ||
| Return | osid.control.SceneQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSettingIdTerms | ||
| Description |
Gets the setting | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSettingTerms | ||
| Description |
Gets the setting query terms. | ||
| Return | osid.control.SettingQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActionQueryInspectorRecord | ||
| Description |
Gets the action query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | actionRecordType | an action record type |
| Return | osid.control.records.ActionQueryInspectorRecord | the action query inspector record | |
| Errors | NULL_ARGUMENT | actionRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(actionRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |