Interface | osid.cataloging.CatalogSearchSession | ||
---|---|---|---|
Implements | osid.cataloging.CatalogQuerySession | ||
Description |
This session provides methods for searching Catalogs may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getCatalogSearch | ||
Description |
Gets a catalog search. | ||
Return | osid.cataloging.CatalogSearch | the catalog search | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogSearchOrder | ||
Description |
Gets a subject search order. The | ||
Return | osid.cataloging.CatalogSearchOrder | the catalog search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.cataloging.CatalogQuery | catalogQuery | the catalog query |
osid.cataloging.CatalogSearch | catalogSearch | the catalog search | |
Return | osid.cataloging.CatalogSearchResults | the search results | |
Errors | NULL_ARGUMENT | catalogQuery or catalogSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | catalogQuery or catalogSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogQueryFromInspector | ||
Description |
Gets a catalog query from an inspector. The inspector
is available from an | ||
Parameters | osid.cataloging.CatalogQueryInspector | catalogQueryInspector | a catalog query inspector |
Return | osid.cataloging.CatalogQuery | the catalog query | |
Errors | NULL_ARGUMENT | catalogQueryInspector is null | |
UNSUPPORTED | catalogQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |