OSID - osid.control.SettingSmartSystemSession Service Interface Definition

Interface	osid.control.SettingSmartSystemSession
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 `SettingQuery` can be retrieved from this session and systemped to this `System` to create a virtual collection of `Settings`. The settings may be sequenced using the `SettingSearchOrder` from this session. This `System` has a default query that matches any setting and a default search order that specifies no sequencing. The queries may be examined using a `SettingQueryInspector`. The query may be modified by converting the inspector back to a `SettingQuery`.
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	getSettingQuery
Description	Gets a setting query.
Return	`osid.control.SettingQuery`		the setting query
Compliance	`mandatory`		This method must be implemented.
Method	getSettingSearchOrder
Description	Gets a setting search order.
Return	`osid.control.SettingSearchOrder`		the setting search order
Compliance	`mandatory`		This method must be implemented.
Method	applySettingQuery
Description	Applies a setting query to this system.
Parameters	`osid.control.SettingQuery`	`settingQuery`	the setting query
Errors	NULL_ARGUMENT		`settingQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`settingQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectSettingQuery
Description	Gets a setting query inspector for this system.
Return	`osid.control.SettingQueryInspector`		the setting query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applySettingSequencing
Description	Applies a setting search order to this system.
Parameters	`osid.control.SettingSearchOrder`	`settingSearchOrder`	the setting search order
Errors	NULL_ARGUMENT		`settingSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`settingSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSettingQueryFromInspector
Description	Gets a setting query from an inspector.
Parameters	`osid.control.SettingQueryInspector`	`settingQueryInspector`	a setting query inspector
Return	`osid.control.SettingQuery`		the setting query
Errors	NULL_ARGUMENT		`settingQueryInspector` is `null`
Errors	UNSUPPORTED		`settingQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.