OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
hold package
Version 3.0.0
Release Candidate Preview
| Interface | osid.hold.HoldSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing hold searches. | ||
| Method | searchAmongHolds | ||
| Description |
Execute this search among the given list of holds. | ||
| Parameters | osid.id.IdList | holdIds | list of holds |
| Errors | NULL_ARGUMENT | holdIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderHoldResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.hold.HoldSearchOrder | holdSearchOrder | hold search order |
| Errors | NULL_ARGUMENT | holdSearchOrder is null | |
| UNSUPPORTED | holdSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getHoldSearchRecord | ||
| Description |
Gets the hold search record corresponding to the given
hold search record | ||
| Parameters | osid.type.Type | holdSearchRecordType | a hold search record type |
| Return | osid.hold.records.HoldSearchRecord | the hold search 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. | |