Interface | osid.cataloging.CatalogSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing the search query for
| ||
Method | searchAmongCatalogs | ||
Description |
Execute this search among the given list of catalogs. | ||
Parameters | osid.id.IdList | catalogIds | list of catalogs |
Errors | NULL_ARGUMENT | catalogIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderCatalogResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.cataloging.CatalogSearchOrder | catalogSearchOrder | catalog search order |
Errors | NULL_ARGUMENT | catalogSearchOrder is null | |
UNSUPPORTED | catalogSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogSearchRecord | ||
Description |
Gets the catalog search record corresponding to the
given catalog search record | ||
Parameters | osid.type.Type | catalogSearchRecordType | a catalog search record type |
Return | osid.cataloging.records.CatalogSearchRecord | the catalog search record | |
Errors | NULL_ARGUMENT | catalogSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(catalogSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |