OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
configuration package
Version 3.0.0
Release Candidate Preview
| Interface | osid.configuration.ConfigurationQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining configuration queries. | ||
| Method | getRegistryTerms | ||
| Description |
Gets the registry query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParameterIdTerms | ||
| Description |
Gets the parameter | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParameterTerms | ||
| Description |
Gets the parameter query terms. | ||
| Return | osid.configuration.ParameterQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorConfigurationIdTerms | ||
| Description |
Gets the ancestor configuration | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorConfigurationTerms | ||
| Description |
Gets the ancestor configuration query terms. | ||
| Return | osid.configuration.ConfigurationQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantConfigurationIdTerms | ||
| Description |
Gets the descendant configuration | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantConfigurationTerms | ||
| Description |
Gets the descendant configuration query terms. | ||
| Return | osid.configuration.ConfigurationQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getConfigurationQueryInspectorRecord | ||
| Description |
Gets the configuration query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | configurationRecordType | a configuration record type |
| Return | osid.configuration.records.ConfigurationQueryInspectorRecord | the configuration query inspector record | |
| Errors | NULL_ARGUMENT | configurationRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(configurationRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |