Interface | osid.offering.CatalogueSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getCatalogues | ||
Description |
Gets the catalogue list resulting from a search. | ||
Return | osid.offering.CatalogueList | the catalogue list | |
Errors | ILLEGAL_STATE | the list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogueQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.offering.CatalogueQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogueSearchResultsRecord | ||
Description |
Gets the record corresponding to the given catalogue search record Type. This method is used to retrieve an object implementing the requested record. | ||
Parameters | osid.type.Type | catalogueSearchRecordType | a catalogue search record type |
Return | osid.offering.records.CatalogueSearchResultsRecord | the catalogue search results 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. |