OSID - osid.control.rules.ActionEnablerSmartSystemSession Service Interface Definition

Interface	osid.control.rules.ActionEnablerSmartSystemSession
Implements	`osid.OsidSession`
Used By	`osid.control.rules.ControlRulesManager`
Used By	`osid.control.rules.ControlRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic systems. An `ActionEnablerQuery` can be retrieved from this session and mapped to this `System` to create a virtual collection of action enablers. The action enablers may be sequenced using the `ActionEnablerSearchOrder` from this session. This `System` has a default query that matches any action enabler and a default search order that specifies no sequencing. The queries may be examined using an `ActionEnablerQueryInspector`. The query may be modified by converting the inspector back to an `ActionEnablerQuery`.
Method	getSystemId
Description	Gets the `System` `Id` associated with this session.
Return	`osid.id.Id`		the `System Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getSystem
Description	Gets the `System` associated with this session.
Return	`osid.control.System`		the system
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartSystems
Description	Tests if this user can manage smart systems. 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 system management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActionEnablerQuery
Description	Gets an action enabler query.
Return	`osid.control.rules.ActionEnablerQuery`		the action enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getActionEnablerSearchOrder
Description	Gets an action enabler search order.
Return	`osid.control.rules.ActionEnablerSearchOrder`		the action enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyActionEnablerQuery
Description	Applies an action enabler query to this system.
Parameters	`osid.control.rules.ActionEnablerQuery`	`actionEnablerQuery`	the action enabler query
Errors	NULL_ARGUMENT		`actionEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`actionEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectActionEnablerQuery
Description	Gets an action enabler query inspector for this system.
Return	`osid.control.rules.ActionEnablerQueryInspector`		the action enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyActionEnablerSequencing
Description	Applies an action enabler search order to this system.
Parameters	`osid.control.rules.ActionEnablerSearchOrder`	`actionEnablerSearchOrder`	the action enabler search order
Errors	NULL_ARGUMENT		`actionEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`actionEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getActionEnablerQueryFromInspector
Description	Gets an action enabler query from an inspector.
Parameters	`osid.control.rules.ActionEnablerQueryInspector`	`actionEnablerQueryInspector`	an action enabler query inspector
Return	`osid.control.rules.ActionEnablerQuery`		the action enabler query
Errors	NULL_ARGUMENT		`actionEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`actionEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.