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

Interface	osid.control.rules.InputEnablerSmartSystemSession
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 `InputEnablerQuery` can be retrieved from this session and mapped to this `System` to create a virtual collection of input enablers. The input enablers may be sequenced using the `InputEnablerSearchOrder` from this session. This `System` has a default query that matches any input enabler and a default search order that specifies no sequencing. The queries may be examined using an `InputEnablerQueryInspector`. The query may be modified by converting the inspector back to an `InputEnablerQuery`.
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	getInputEnablerQuery
Description	Gets an input enabler query.
Return	`osid.control.rules.InputEnablerQuery`		the input enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getInputEnablerSearchOrder
Description	Gets an input enabler search order.
Return	`osid.control.rules.InputEnablerSearchOrder`		the input enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyInputEnablerQuery
Description	Applies an input enabler query to this system.
Parameters	`osid.control.rules.InputEnablerQuery`	`inputEnablerQuery`	the input enabler query
Errors	NULL_ARGUMENT		`inputEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`inputEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectInputEnablerQuery
Description	Gets an input enabler query inspector for this system.
Return	`osid.control.rules.InputEnablerQueryInspector`		the input enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyInputEnablerSequencing
Description	Applies an input enabler search order to this system.
Parameters	`osid.control.rules.InputEnablerSearchOrder`	`inputEnablerSearchOrder`	the input enabler search order
Errors	NULL_ARGUMENT		`inputEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`inputEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getInputEnablerQueryFromInspector
Description	Gets an input enabler query from an inspector.
Parameters	`osid.control.rules.InputEnablerQueryInspector`	`inputEnablerQueryInspector`	an input enabler query inspector
Return	`osid.control.rules.InputEnablerQuery`		the input enabler query
Errors	NULL_ARGUMENT		`inputEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`inputEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.