OSID - osid.control.DeviceSmartSystemSession Service Interface Definition

Interface	osid.control.DeviceSmartSystemSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `DeviceQuery` can be retrieved from this session and systemped to this `System` to create a virtual collection of `Devices.` The devices may be sequenced using the `DeviceSearchOrder` from this session. This `System` has a default query that matches any device and a default search order that specifies no sequencing. The queries may be examined using a `DeviceQueryInspector.` The query may be modified by converting the inspector back to a `DeviceQuery.`
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	getDeviceQuery
Description	Gets a device query.
Return	`osid.control.DeviceQuery`		the device query
Compliance	`mandatory`		This method must be implemented.
Method	getDeviceSearchOrder
Description	Gets a device search order.
Return	`osid.control.DeviceSearchOrder`		the device search order
Compliance	`mandatory`		This method must be implemented.
Method	applyDeviceQuery
Description	Applies a device query to this system.
Parameters	`osid.control.DeviceQuery`	`deviceQuery`	the device query
Errors	NULL_ARGUMENT		`deviceQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`deviceQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectDeviceQuery
Description	Gets a device query inspector for this system.
Return	`osid.control.DeviceQueryInspector`		the device query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyDeviceSequencing
Description	Applies a device search order to this system.
Parameters	`osid.control.DeviceSearchOrder`	`deviceSearchOrder`	the device search order
Errors	NULL_ARGUMENT		`deviceSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`deviceSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDeviceQueryFromInspector
Description	Gets a device query from an inspector.
Parameters	`osid.control.DeviceQueryInspector`	`deviceQueryInspector`	a device query inspector
Return	`osid.control.DeviceQuery`		the device query
Errors	NULL_ARGUMENT		`deviceQueryInspector` is `null`
Errors	UNSUPPORTED		`deviceQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.