OSID - osid.sequencing.ChainSearchSession Service Interface Definition

Interface	osid.sequencing.ChainSearchSession
Implements	`osid.sequencing.ChainQuerySession`
Used By	`osid.sequencing.SequencingManager`
Used By	`osid.sequencing.SequencingProxyManager`
Description	This session provides methods for searching among `Chain` objects. The search query is constructed using the `ChainQuery` . `getChainsByQuery()` is the basic search method and returns a list of `Chains` . A more advanced search may be performed with `getChainsBySearch()` . It accepts an `ChainSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getChainsBySearch()` returns an `ChainSearchResults` that can be used to access the resulting `ChainList` or be used to perform a search within the result set through `ChainSearch` . This session defines views that offer differing behaviors for searching. federated antimatroid view: searches include chains in antimatroids of which this antimatroid is an ancestor in the antimatroid hierarchy isolated antimatroid view: searches are restricted to chains in this antimatroid Chains may have a query record indicated by their respective record types. The query record is accessed via the `ChainQuery` .
Method	getChainSearch
Description	Gets a chain search.
Return	`osid.sequencing.ChainSearch`		the chain search
Compliance	`mandatory`		This method must be implemented.
Method	getChainSearchOrder
Description	Gets a chain search order. The `ChainSearchOrder` is supplied to a `ChainSearch` to specify the ordering of results.
Return	`osid.sequencing.ChainSearchOrder`		the chain search order
Compliance	`mandatory`		This method must be implemented.
Method	getChainsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.sequencing.ChainQuery`	`chainQuery`	the chain query
Parameters	`osid.sequencing.ChainSearch`	`chainSearch`	the chain search
Return	`osid.sequencing.ChainSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`chainQuery` or `chainSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`chainQuery` or `chainSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getChainQueryFromInspector
Description	Gets a chain query from an inspector. The inspector is available from a `ChainSearchResults` .
Parameters	`osid.sequencing.ChainQueryInspector`	`chainQueryInspector`	a chain query inspector
Return	`osid.sequencing.ChainQuery`		the chain query
Errors	NULL_ARGUMENT		`chainQueryInspector` is `null`
Errors	UNSUPPORTED		`chainQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.