OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
control package
Version 3.0.0
Release Candidate Preview
| Interface | osid.control.TriggerQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRuleQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| Description |
This is the query inspector for examining trigger queries. | ||
| Method | getControllerIdTerms | ||
| Description |
Gets the controller | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getControllerTerms | ||
| Description |
Gets the controller query terms. | ||
| Return | osid.control.ControllerQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTurnedOnTerms | ||
| Description |
Gets the ON event query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTurnedOffTerms | ||
| Description |
Gets the OFF event query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getChangedVariableAmountTerms | ||
| Description |
Gets the changed amount event query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getExceedsVariableAmountTerms | ||
| Description |
Gets the exceeds amount event query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDeceedsVariableAmountTerms | ||
| Description |
Gets the deceeds amount event query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getChangedDiscreetStateTerms | ||
| Description |
Gets the changed state event query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDiscreetStateIdTerms | ||
| Description |
Gets the controller | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDiscreetStateTerms | ||
| Description |
Gets the discreet state query terms. | ||
| Return | osid.control.ControllerQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| 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 | 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 | getSystemIdTerms | ||
| Description |
Gets the system | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSystemTerms | ||
| Description |
Gets the system query terms. | ||
| Return | osid.control.SystemQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTriggerQueryInspectorRecord | ||
| Description |
Gets the trigger query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | triggerRecordType | a trigger record type |
| Return | osid.control.records.TriggerQueryInspectorRecord | the trigger query inspector record | |
| Errors | NULL_ARGUMENT | triggerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(triggerRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |