OSID - osid.configuration.rules.ValueEnablerSmartConfigurationSession Service Interface Definition

Interface	osid.configuration.rules.ValueEnablerSmartConfigurationSession
Implements	`osid.OsidSession`
Used By	`osid.configuration.rules.ConfigurationRulesManager`
Used By	`osid.configuration.rules.ConfigurationRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic configurations. A `ValueEnablerQuery` can be retrieved from this session and mapped to this `Configuration` to create a virtual collection of value enablers. The value enablers may be sequenced using the `ValueEnablerSearchOrder` from this session. This `Configuration` has a default query that matches any value enabler and a default search order that specifies no sequencing. The queries may be examined using a `ValueEnablerQueryInspector`. The query may be modified by converting the inspector back to a `ValueEnablerQuery`.
Method	getConfigurationId
Description	Gets the `Configuration` `Id` associated with this session.
Return	`osid.id.Id`		the `Configuration Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getConfiguration
Description	Gets the `Configuration` associated with this session.
Return	`osid.configuration.Configuration`		the configuration
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartConfigurations
Description	Tests if this user can manage smart configurations. 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 configuration management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getValueEnablerQuery
Description	Gets a value enabler query.
Return	`osid.configuration.rules.ValueEnablerQuery`		the value enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getValueEnablerSearchOrder
Description	Gets a value enabler search order.
Return	`osid.configuration.rules.ValueEnablerSearchOrder`		the value enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyValueEnablerQuery
Description	Applies a value enabler query to this configuration.
Parameters	`osid.configuration.rules.ValueEnablerQuery`	`valueEnablerQuery`	the value enabler query
Errors	NULL_ARGUMENT		`valueEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`valueEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectValueEnablerQuery
Description	Gets a value enabler query inspector for this configuration.
Return	`osid.configuration.rules.ValueEnablerQueryInspector`		the value enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyValueEnablerSequencing
Description	Applies a value enabler search order to this configuration.
Parameters	`osid.configuration.rules.ValueEnablerSearchOrder`	`valueEnablerSearchOrder`	the value enabler search order
Errors	NULL_ARGUMENT		`valueEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`valueEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getValueEnablerQueryFromInspector
Description	Gets a value enabler query from an inspector.
Parameters	`osid.configuration.rules.ValueEnablerQueryInspector`	`valueEnablerQueryInspector`	a value enabler query inspector
Return	`osid.configuration.rules.ValueEnablerQuery`		the value enabler query
Errors	NULL_ARGUMENT		`valueEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`valueEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.