OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
offering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.offering.CatalogueSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing catalogue searches. | ||
| Method | searchAmongCatalogues | ||
| Description |
Execute this search among the given list of catalogues. | ||
| Parameters | osid.id.IdList | catalogueIds | list of catalogues |
| Errors | NULL_ARGUMENT | catalogueIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCatalogueResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.offering.CatalogueSearchOrder | catalogueSearchOrder | catalogue search order |
| Errors | NULL_ARGUMENT | catalogueSearchOrder is null | |
| UNSUPPORTED | catalogueSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCatalogueSearchRecord | ||
| Description |
Gets the record corresponding to the given catalogue
search record | ||
| Parameters | osid.type.Type | catalogueSearchRecordType | a catalogue search record type |
| Return | osid.offering.records.CatalogueSearchRecord | the catalogue search record | |
| Errors | NULL_ARGUMENT | catalogueSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(catalogueSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |