| Interface | osid.hold.HoldSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getHolds | ||
| Description |
Gets the hold list resulting from a search. | ||
| Return | osid.hold.HoldList | the hold list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getHoldQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.hold.HoldQueryInspector | the hold query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getHoldSearchResultsRecord | ||
| Description |
Gets the hold search results record corresponding to
the given hold search record | ||
| Parameters | osid.type.Type | holdSearchRecordType | a hold search record type |
| Return | osid.hold.records.HoldSearchResultsRecord | the hold search results record | |
| Errors | NULL_ARGUMENT | holdSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(holdSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |