Interface | osid.cataloging.CatalogSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getCatalogs | ||
Description |
Gets the catalog list resulting from the search. | ||
Return | osid.cataloging.CatalogList | the catalogs list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.cataloging.CatalogQueryInspector | the catalog query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogSearchResultsRecord | ||
Description |
Gets the catalog search results record corresponding to
the given catalog search record | ||
Parameters | osid.type.Type | catalogSearchRecordType | a catalog search record type |
Return | osid.cataloging.records.CatalogSearchResultsRecord | the catalog search results 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. |