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

Interface	osid.control.rules.DeviceEnablerSmartSystemSession
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. A `DeviceEnablerQuery` can be retrieved from this session and mapped to this `System` to create a virtual collection of device enablers. The device enablers may be sequenced using the `DeviceEnablerSearchOrder` from this session. This `System` has a default query that matches any device enabler and a default search order that specifies no sequencing. The queries may be examined using a `DeviceEnablerQueryInspector`. The query may be modified by converting the inspector back to a `DeviceEnablerQuery`.
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	getDeviceEnablerQuery
Description	Gets a device enabler query.
Return	`osid.control.rules.DeviceEnablerQuery`		the device enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getDeviceEnablerSearchOrder
Description	Gets a device enabler search order.
Return	`osid.control.rules.DeviceEnablerSearchOrder`		the device enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyDeviceEnablerQuery
Description	Applies a device enabler query to this system.
Parameters	`osid.control.rules.DeviceEnablerQuery`	`deviceEnablerQuery`	the device enabler query
Errors	NULL_ARGUMENT		`deviceEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`deviceEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectDeviceEnablerQuery
Description	Gets a device enabler query inspector for this system.
Return	`osid.control.rules.DeviceEnablerQueryInspector`		the device enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyDeviceEnablerSequencing
Description	Applies a device enabler search order to this system
Parameters	`osid.control.rules.DeviceEnablerSearchOrder`	`deviceEnablerSearchOrder`	the device enabler search order
Errors	NULL_ARGUMENT		`deviceEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`deviceEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDeviceEnablerQueryFromInspector
Description	Gets a device enabler query from an inspector.
Parameters	`osid.control.rules.DeviceEnablerQueryInspector`	`deviceEnablerQueryInspector`	a device enabler query inspector
Return	`osid.control.rules.DeviceEnablerQuery`		the device enabler query
Errors	NULL_ARGUMENT		`deviceEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`deviceEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.