| Interface | osid.hold.BlockSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getBlocks | ||
| Description |
Gets the block list resulting from a search. | ||
| Return | osid.hold.BlockList | the block list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBlockQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.hold.BlockQueryInspector | the block query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBlockSearchResultsRecord | ||
| Description |
Gets the block search results record corresponding to
the given block search record | ||
| Parameters | osid.type.Type | blockSearchRecordType | a block search record type |
| Return | osid.hold.records.BlockSearchResultsRecord | the block search results 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. | |