OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
control package
Version 3.0.0
Release Candidate Preview
| Interface | osid.control.SystemQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining system queries. | ||
| Method | getDeviceIdTerms | ||
| Description |
Gets the device | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDeviceTerms | ||
| Description |
Gets the device query terms. | ||
| Return | osid.control.DeviceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| 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 | getInputIdTerms | ||
| Description |
Gets the input | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInputTerms | ||
| Description |
Gets the input query terms. | ||
| Return | osid.control.InputQueryInspector[] | 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 | 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 | getTriggerIdTerms | ||
| Description |
Gets the trigger | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTriggerTerms | ||
| Description |
Gets the trigger query terms. | ||
| Return | osid.control.TriggerQueryInspector[] | 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 | getAncestorSystemIdTerms | ||
| Description |
Gets the ancestor system | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorSystemTerms | ||
| Description |
Gets the ancestor system query terms. | ||
| Return | osid.control.SystemQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantSystemIdTerms | ||
| Description |
Gets the descendant system | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantSystemTerms | ||
| Description |
Gets the descendant system query terms. | ||
| Return | osid.control.SystemQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSystemQueryInspectorRecord | ||
| Description |
Gets the system query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | systemRecordType | a system record type |
| Return | osid.control.records.SystemQueryInspectorRecord | the system query inspector record | |
| Errors | NULL_ARGUMENT | systemRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(systemRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |