Interface | osid.hold.BlockSearchSession | ||
---|---|---|---|
Implements | osid.hold.BlockQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Blocks may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getBlockSearch | ||
Description |
Gets a block search. | ||
Return | osid.hold.BlockSearch | the block search | |
Compliance | mandatory | This method must be implemented. | |
Method | getBlockSearchOrder | ||
Description |
Gets a block search order. The | ||
Return | osid.hold.BlockSearchOrder | the block search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getBlocksBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.hold.BlockQuery | blockQuery | the block query |
osid.hold.BlockSearch | blockSearch | the block search | |
Return | osid.hold.BlockSearchResults | the block search results | |
Errors | NULL_ARGUMENT | blockQuery or blockSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | blockQuery or blockSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBlockQueryFromInspector | ||
Description |
Gets a block query from an inspector. The inspector is
available from a | ||
Parameters | osid.hold.BlockQueryInspector | blockQueryInspector | a block query inspector |
Return | osid.hold.BlockQuery | the block query | |
Errors | NULL_ARGUMENT | blockQueryInspector is null | |
UNSUPPORTED | blockQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |