OSID - osid.repository.CompositionQuerySession Service Interface Definition

Interface	osid.repository.CompositionQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `Composition` objects. The search query is constructed using the `CompositionQuery.` This session defines views that offer differing behaviors when searching. federated repository view: searches include compositions in repositories of which this repository is an ancestor in the repository hierarchy isolated repository view: searches are restricted to subjects in this repository sequestered composition viiew: All composition methods suppress sequestered compositions. unsequestered composition view: All composition methods return all compositions. Compositions may have a query record indicated by their respective record types. The query record is accessed via the `CompositionQuery.`
Method	getRepositoryId
Description	Gets the `Repository` `Id` associated with this session.
Return	`osid.id.Id`		the `Repository Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRepository
Description	Gets the `Repository` associated with this session.
Return	`osid.repository.Repository`		the `Repository` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchCompositions
Description	Tests if this user can perform `Composition` searches. 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 opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedRepositoryView
Description	Federates the view for methods in this session. A federated view will include compositions in repositories which are children of this repository in the repository hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedRepositoryView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this repository only.
Compliance	`mandatory`		This method is must be implemented.
Method	useSequesteredCompositionView
Description	The methods in this session omit sequestered compositions.
Compliance	`mandatory`		This method is must be implemented.
Method	useUnsequesteredCompositionView
Description	The methods in this session return all compositions, including sequestered compositions.
Compliance	`mandatory`		This method is must be implemented.
Method	getCompositionQuery
Description	Gets a composition query.
Return	`osid.repository.CompositionQuery`		the composition query
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionsByQuery
Description	Gets a list of `Compositions` matching the given composition query.
Parameters	`osid.repository.CompositionQuery`	`compositionQuery`	the composition query
Return	`osid.repository.CompositionList`		the returned `CompositionList`
Errors	NULL_ARGUMENT		`compositionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`compositionQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.