OSID Specifications
configuration rules package
Version 3.1.0
configuration rules package
Version 3.1.0
| Interface | osid.configuration.rules.ValueEnablerQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidEnablerQueryInspector | ||
| Used By | osid.configuration.rules.ValueEnablerSearchResults | ||
osid.configuration.rules.ValueEnablerSmartConfigurationSession | |||
| Description |
This is the query inspector for examining value enabler queries. | ||
| Method | getRuledValueIdTerms | ||
| Description |
Gets the value | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRuledValueTerms | ||
| Description |
Gets the value query terms. | ||
| Return | osid.configuration.ValueQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getConfigurationIdTerms | ||
| Description |
Gets the configuration | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getConfigurationTerms | ||
| Description |
Gets the configuration query terms. | ||
| Return | osid.configuration.ConfigurationQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getValueEnablerQueryInspectorRecord | ||
| Description |
Gets the value enabler query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | valueEnablerRecordType | a value enabler record type |
| Return | osid.configuration.rules.records.ValueEnablerQueryInspectorRecord | the value enabler query inspector record | |
| Errors | NULL_ARGUMENT | valueEnablerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(valueEnablerRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |