| Interface | osid.cataloging.rules.CatalogEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.cataloging.rules.CatalogEnablerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getCatalogEnablers | ||
| Description |
Gets the | ||
| Return | osid.cataloging.rules.CatalogEnablerList | the catalog enabler list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCatalogEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.cataloging.rules.CatalogEnablerQueryInspector | the catalog enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCatalogEnablerSearchResultsRecord | ||
| Description |
Gets the catalog enabler search results record
corresponding to the given catalog enabler search record
| ||
| Parameters | osid.type.Type | catalogEnablerSearchRecordType | a catalog enabler search record type |
| Return | osid.cataloging.rules.records.CatalogEnablerSearchResultsRecord | the catalog enabler search results record | |
| Errors | NULL_ARGUMENT | catalogEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(catalogEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |