OSID - osid.control.ControllerSmartSystemSession Service Interface Definition

Interface	osid.control.ControllerSmartSystemSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ControllerQuery` can be retrieved from this session and mapped to this `System` to create a virtual collection of controllers. The controllers may be sequenced using the `ControllerSearchOrder` from this session. This `System` has a default query that matches any controller and a default search order that specifies no sequencing. The queries may be examined using a `ControllerQueryInspector.` The query may be modified by converting the inspector back to a `ControllerQuery.`
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	getControllerQuery
Description	Gets a controller query.
Return	`osid.control.ControllerQuery`		the controller query
Compliance	`mandatory`		This method must be implemented.
Method	getControllerSearchOrder
Description	Gets a controller search order.
Return	`osid.control.ControllerSearchOrder`		the controller search order
Compliance	`mandatory`		This method must be implemented.
Method	applyControllerQuery
Description	Applies a controller query to this system.
Parameters	`osid.control.ControllerQuery`	`controllerQuery`	the controller query
Errors	NULL_ARGUMENT		`controllerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`controllerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspecControllerQuery
Description	Gets a controller query inspector for this system.
Return	`osid.control.ControllerQueryInspector`		the controller query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyControllerSequencing
Description	Applies a controller search order to this system.
Parameters	`osid.control.ControllerSearchOrder`	`controllerSearchOrder`	the controller search order
Errors	NULL_ARGUMENT		`controllerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`controllerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getControllerQueryFromInspector
Description	Gets a controller query from an inspector.
Parameters	`osid.control.ControllerQueryInspector`	`controllerQueryInspector`	a controller query inspector
Return	`osid.control.ControllerQuery`		the controller query
Errors	NULL_ARGUMENT		`controllerQueryInspector` is `null`
Errors	UNSUPPORTED		`controllerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.