OSID Specifications
configuration package
Version 3.1.0
configuration package
Version 3.1.0
| Interface | osid.configuration.ParameterQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRuleQueryInspector | ||
| Used By | osid.configuration.ConfigurationQueryInspector | ||
osid.configuration.ParameterSearchResults | |||
osid.configuration.ParameterSmartConfigurationSession | |||
osid.configuration.ValueQueryInspector | |||
osid.configuration.rules.ParameterProcessorQueryInspector | |||
| Description |
Inspects a parameter query. | ||
| Method | getValueSyntaxTerms | ||
| Description |
Gets the value syntax query terms. | ||
| Return | osid.search.terms.SyntaxTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getValueCoordinateTypeTerms | ||
| Description |
Gets the coordinate record type query terms. | ||
| Return | osid.search.terms.TypeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getValueHeadingTypeTerms | ||
| Description |
Gets the heading record type query terms. | ||
| Return | osid.search.terms.TypeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getValueObjectTypeTerms | ||
| Description |
Gets the object value type query terms. | ||
| Return | osid.search.terms.TypeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getValueSpatialUnitRecordTypeTerms | ||
| Description |
Gets the spatial unit record type query terms. | ||
| Return | osid.search.terms.TypeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getValueVersionSchemeTerms | ||
| Description |
Gets the version type query terms. | ||
| Return | osid.search.terms.TypeTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getValueTerms | ||
| Description |
Gets the value query terms. | ||
| Return | osid.configuration.ValueQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getValuesShuffledTerms | ||
| Description |
Gets the shuffle query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | 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 | getParameterQueryInspectorRecord | ||
| Description |
Gets the parameter query record corresponding to the
given | ||
| Parameters | osid.type.Type | parameterRecordType | a parameter record type |
| Return | osid.configuration.records.ParameterQueryInspectorRecord | the parameter query inspector record | |
| Errors | NULL_ARGUMENT | parameterRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(parameterRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |