OSID - osid.repository.rules.CompositionEnablerSmartRepositorySession Service Interface Definition

Interface	osid.repository.rules.CompositionEnablerSmartRepositorySession
Implements	`osid.OsidSession`
Used By	`osid.repository.rules.RepositoryRulesManager`
Used By	`osid.repository.rules.RepositoryRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic repositories. A `CompositionEnablerQuery` can be retrieved from this session and mapped to this `Repository` to create a virtual collection of composition enablers. The composition enablers may be sequenced using the `CompositionEnablerSearchOrder` from this session. This `Repository` has a default query that matches any composition enabler and a default search order that specifies no sequencing. The queries may be examined using a `CompositionEnablerQueryInspector`. The query may be modified by converting the inspector back to a `CompositionEnablerQuery`.
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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartRepositories
Description	Tests if this user can manage smart repositories. 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	getCompositionEnablerQuery
Description	Gets a composition enabler query.
Return	`osid.repository.rules.CompositionEnablerQuery`		the composition enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionEnablerSearchOrder
Description	Gets a composition enabler search order.
Return	`osid.repository.rules.CompositionEnablerSearchOrder`		the composition enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCompositionEnablerQuery
Description	Applies a composition enabler query to this repository.
Parameters	`osid.repository.rules.CompositionEnablerQuery`	`compositionEnablerQuery`	the composition enabler query
Errors	NULL_ARGUMENT		`compositionEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`compositionEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCompositionEnablerQuery
Description	Gets a composition enabler query inspector for this repository.
Return	`osid.repository.rules.CompositionEnablerQueryInspector`		the composition enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCompositionEnablerSequencing
Description	Applies a composition enabler search order to this repository.
Parameters	`osid.repository.rules.CompositionEnablerSearchOrder`	`compositionEnablerSearchOrder`	the composition enabler search order
Errors	NULL_ARGUMENT		`compositionEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`compositionEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionEnablerQueryFromInspector
Description	Gets a composition enabler query from an inspector.
Parameters	`osid.repository.rules.CompositionEnablerQueryInspector`	`compositionEnablerQueryInspector`	a composition enabler query inspector
Return	`osid.repository.rules.CompositionEnablerQuery`		the composition enabler query
Errors	NULL_ARGUMENT		`compositionEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`compositionEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.