OSID Specifications
cataloging rules package
Version 3.0.0
Release Candidate Preview
cataloging rules package
Version 3.0.0
Release Candidate Preview
| Interface | osid.cataloging.rules.CatalogEnablerQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidEnablerQueryInspector | ||
| Description |
This is the query inspector for examining catalog enabler queries. | ||
| Method | getRuledCatalogIdTerms | ||
| Description |
Gets the catalog | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRuledCatalogTerms | ||
| Description |
Gets the catalog query terms. | ||
| Return | osid.cataloging.CatalogQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCatalogIdTerms | ||
| Description |
Gets the catalog | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCatalogTerms | ||
| Description |
Gets the catalog query terms. | ||
| Return | osid.cataloging.CatalogQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCatalogEnablerQueryInspectorRecord | ||
| Description |
Gets the catalog enabler query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | catalogEnablerRecordType | a catalog enabler record type |
| Return | osid.cataloging.rules.records.CatalogEnablerQueryInspectorRecord | the catalog enabler query inspector record | |
| Errors | NULL_ARGUMENT | catalogEnablerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(catalogEnablerRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |