OSID - osid.sequencing.ChainQuerySession Service Interface Definition

Interface	osid.sequencing.ChainQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.sequencing.ChainSearchSession`
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`. 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	getAntimatroidId
Description	Gets the `Antimatroid` `Id` associated with this session.
Return	`osid.id.Id`		the `Antimatroid Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAntimatroid
Description	Gets the `Antimatroid` associated with this session.
Return	`osid.sequencing.Antimatroid`		the antimatroid
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchChains
Description	Tests if this user can perform `Chain` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedAntimatroidView
Description	Federates the view for methods in this session. A federated view will include chains in antimatroids which are children of this antimatroid in the antimatroid hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAntimatroidView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this antimatroid only.
Compliance	`mandatory`		This method is must be implemented.
Method	getChainQuery
Description	Gets a chain query.
Return	`osid.sequencing.ChainQuery`		the chain query
Compliance	`mandatory`		This method must be implemented.
Method	getChainsByQuery
Description	Gets a list of `Chains` matching the given chain query.
Parameters	`osid.sequencing.ChainQuery`	`chainQuery`	the chain query
Return	`osid.sequencing.ChainList`		the returned `ChainList`
Errors	NULL_ARGUMENT		`chainQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`chainQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.