OSID - osid.control.SceneSmartSystemSession Service Interface Definition

Interface	osid.control.SceneSmartSystemSession
Implements	`osid.OsidSession`
Used By	`osid.control.ControlManager`
Used By	`osid.control.ControlProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `SceneQuery` can be retrieved from this session and systemped to this `System` to create a virtual collection of `Scenes`. The scenes may be sequenced using the `SceneSearchOrder` from this session. This `System` has a default query that matches any scene and a default search order that specifies no sequencing. The queries may be examined using a `SceneQueryInspector`. The query may be modified by converting the inspector back to a `SceneQuery`.
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	getSceneQuery
Description	Gets a scene query.
Return	`osid.control.SceneQuery`		the scene query
Compliance	`mandatory`		This method must be implemented.
Method	getSceneSearchOrder
Description	Gets a scene search order.
Return	`osid.control.SceneSearchOrder`		the scene search order
Compliance	`mandatory`		This method must be implemented.
Method	applySceneQuery
Description	Applies a scene query to this system.
Parameters	`osid.control.SceneQuery`	`sceneQuery`	the scene query
Errors	NULL_ARGUMENT		`sceneQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`sceneQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectSceneQuery
Description	Gets a scene query inspector for this system.
Return	`osid.control.SceneQueryInspector`		the scene query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applySceneSequencing
Description	Applies a scene search order to this system.
Parameters	`osid.control.SceneSearchOrder`	`sceneSearchOrder`	the scene search order
Errors	NULL_ARGUMENT		`sceneSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`sceneSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSceneQueryFromInspector
Description	Gets a scene query from an inspector.
Parameters	`osid.control.SceneQueryInspector`	`sceneQueryInspector`	a scene query inspector
Return	`osid.control.SceneQuery`		the scene query
Errors	NULL_ARGUMENT		`sceneQueryInspector` is `null`
Errors	UNSUPPORTED		`sceneQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.