Interface | osid.cataloging.CatalogQueryInspector | ||
---|---|---|---|
Implements | osid.OsidCatalogQueryInspector | ||
Description |
This is the query inspector for examining catalog queries. | ||
Method | getIdTerms | ||
Description |
Gets the | ||
Return | osid.search.terms.IdTerm[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorCatalogIdTerms | ||
Description |
Gets the ancestor catalog | ||
Return | osid.search.terms.IdTerm[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorCatalogTerms | ||
Description |
Gets the ancestor catalog query terms. | ||
Return | osid.cataloging.CatalogQueryInspector[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantCatalogIdTerms | ||
Description |
Gets the descendant catalog | ||
Return | osid.search.terms.IdTerm[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantCatalogTerms | ||
Description |
Gets the descendant catalog query terms. | ||
Return | osid.cataloging.CatalogQueryInspector[] | the query terms | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogQueryInspectorRecord | ||
Description |
Gets the catalog query inspector record corresponding
to the given | ||
Parameters | osid.type.Type | catalogRecordType | a catalog record type |
Return | osid.cataloging.records.CatalogQueryInspectorRecord | the catalog query inspector record | |
Errors | NULL_ARGUMENT | catalogRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(catalogRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |