OSID - osid.hold.BlockSearchSession Service Interface Definition

Interface	osid.hold.BlockSearchSession
Implements	`osid.hold.BlockQuerySession`
Description	This session provides methods for searching among `Block` objects. The search query is constructed using the `BlockQuery.` `getBlocksByQuery()` is the basic search method and returns a list of `Blocks.` A more advanced search may be performed with `getBlocksBySearch().` It accepts a `BlockSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBlocksBySearch()` returns a `BlockSearchResults` that can be used to access the resulting `BlockList` or be used to perform a search within the result set through `BlockSearch.` This session defines views that offer differing behaviors for searching. federated oubliette view: searches include blocks in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy isolated oubliette view: searches are restricted to blocks in this oubliette Blocks may have a query record indicated by their respective record types. The query record is accessed via the `BlockQuery.`
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 `BlockSearchOrder` is supplied to a `BlockSearch` to specify the ordering of results.
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
Parameters	`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 `BlockSearchResults.`
Parameters	`osid.hold.BlockQueryInspector`	`blockQueryInspector`	a block query inspector
Return	`osid.hold.BlockQuery`		the block query
Errors	NULL_ARGUMENT		`blockQueryInspector` is `null`
Errors	UNSUPPORTED		`blockQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.