OSID - osid.repository.CompositionSmartRepositorySession Service Interface Definition

Interface	osid.repository.CompositionSmartRepositorySession
Implements	`osid.OsidSession`
Used By	`osid.repository.RepositoryManager`
Used By	`osid.repository.RepositoryProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `CompositionQuery` can be retrieved from this session and mapped to this `Repository` to create a virtual collection of `Compositions`. The compositions may be sequenced using the `CompositionSearchOrder` from this session. This `Repository` has a default query that matches any composition and a default search order that specifies no sequencing. The queries may be examined using a `CompositionQueryInspector`. The query may be modified by converting the inspector back to a `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	canManageSmartRepository
Description	Tests if this user can manage smart repository. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart repository management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getCompositionSearchOrder
Description	Gets a composition search order.
Return	`osid.repository.CompositionSearchOrder`		the composition search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCompositionQuery
Description	Applies a composition query to this repository.
Parameters	`osid.repository.CompositionQuery`	`compositionQuery`	the composition query
Errors	NULL_ARGUMENT		`compositionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`compositionQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCompositionQuery
Description	Gets a composition query inspector for this repository.
Return	`osid.repository.CompositionQueryInspector`		the composition query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCompositionSequencing
Description	Applies a composition search order to this repository.
Parameters	`osid.repository.CompositionSearchOrder`	`compositionSearchOrder`	the composition search order
Errors	NULL_ARGUMENT		`compositionSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`compositionSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionQueryFromInspector
Description	Gets a composition query from an inspector.
Parameters	`osid.repository.CompositionQueryInspector`	`compositionQueryInspector`	a resorce relationship query inspector
Return	`osid.repository.CompositionQuery`		the composition query
Errors	NULL_ARGUMENT		`compositionQueryInspector` is `null`
Errors	UNSUPPORTED		`compositionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.