OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
control package
Version 3.0.0
Release Candidate Preview
| Interface | osid.control.SettingQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| Description |
This is the query inspector for examining setting 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 | getOnTerms | ||
| Description |
Gets the on query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOffTerms | ||
| Description |
Gets the off query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVariablePercentageTerms | ||
| Description |
Gets the variable percentage query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVariableAmountTerms | ||
| Description |
Gets the variable amount query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDiscreetStateIdTerms | ||
| Description |
Gets the discreet state | ||
| 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.process.StateQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRampRateTerms | ||
| Description |
Gets the ramp rate query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | 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 | getSettingQueryInspectorRecord | ||
| Description |
Gets the setting query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | settingRecordType | a setting record type |
| Return | osid.control.records.SettingQueryInspectorRecord | the setting query inspector record | |
| Errors | NULL_ARGUMENT | settingRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(settingRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |