OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
hold package
Version 3.0.0
Release Candidate Preview
| Interface | osid.hold.BlockSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing block searches. | ||
| Method | searchAmongBlocks | ||
| Description |
Execute this search among the given list of blocks. | ||
| Parameters | osid.id.IdList | blockIds | list of blocks |
| Errors | NULL_ARGUMENT | blockIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBlockResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.hold.BlockSearchOrder | blockSearchOrder | block search order |
| Errors | NULL_ARGUMENT | blockSearchOrder is null | |
| UNSUPPORTED | blockSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getBlockSearchRecord | ||
| Description |
Gets the block search record corresponding to the given
block search record | ||
| Parameters | osid.type.Type | blockSearchRecordType | a block search record type |
| Return | osid.hold.records.BlockSearchRecord | the block search record | |
| Errors | NULL_ARGUMENT | blockSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(blockSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |