OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
control package
Version 3.0.0
Release Candidate Preview
| Interface | osid.control.ControllerQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidOperableQueryInspector | |||
| Description |
This is the query inspector for examning controller queries. | ||
| Method | getAddressTerms | ||
| Description |
Gets the address query terms. | ||
| Return | osid.search.terms.StringTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getModelIdTerms | ||
| Description |
Gets the model | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getModelTerms | ||
| Description |
Gets the model query terms. | ||
| Return | osid.inventory.ModelQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVersionTerms | ||
| Description |
Gets the version query terms. | ||
| Return | osid.search.terms.VersionTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVersionSinceTerms | ||
| Description |
Gets the version since query terms. | ||
| Return | osid.search.terms.VersionTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getToggleableTerms | ||
| Description |
Gets the toggle query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVariableTerms | ||
| Description |
Gets the variable query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVariableByPercentageTerms | ||
| Description |
Gets the variable percentage query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVariableMinimumTerms | ||
| Description |
Gets the variable minimum query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVariableMaximumTerms | ||
| Description |
Gets the variable maximum query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDiscreetStatesTerms | ||
| Description |
Gets the discreet query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDiscreetStateIdTerms | ||
| Description |
Gets the state | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDiscreetStateTerms | ||
| Description |
Gets the state query terms. | ||
| Return | osid.process.StateQueryInspector[] | 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 | getControllerQueryInspectorRecord | ||
| Description |
Gets the controller query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | controllerRecordType | a controller record type |
| Return | osid.control.records.ControllerQueryInspectorRecord | the controller query inspector record | |
| Errors | NULL_ARGUMENT | controllerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(controllerRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |