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

Interface	osid.control.rules.DeviceEnablerRuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.control.rules.ControlRulesManager`
Used By	`osid.control.rules.ControlRulesProxyManager`
Description	This session provides methods to retrieve `DeviceEnabler` to `Device` mappings. A `Device` with multiple `DeviceEnablers` means any positive rule evaluation across the enablers result in an effective `Device`. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated system view: All methods in this session operate, retrieve and pertain device enablers defined explicitly in the current system. federated system view: All methods in this session operate, retrieve and pertain to all device enablers defined in this system and any other device enablers implicitly available in this system through system inheritence.
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	canLookupDeviceEnablerRules
Description	Tests if this user can perform lookups of device enabler/device mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeDeviceEnablerRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryDeviceEnablerRuleView
Description	A complete view of the `DeviceEnabler` and `Device` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedSystemView
Description	Federates the view for methods in this session. A federated view will include device enablers in systems which are children of this system in the system hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedSystemView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this system only.
Compliance	`mandatory`		This method is must be implemented.
Method	getDeviceEnablerIdsForDevice
Description	Gets the `DeviceEnabler Id` associated with a `Device`.
Parameters	`osid.id.Id`	`deviceId`	`Id` of the `Device`
Return	`osid.id.IdList`		the device enabler `Ids`
Errors	NOT_FOUND		`deviceId` is not found
	NULL_ARGUMENT		`device` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeviceEnablersForDevice
Description	Gets the `DeviceEnablers` associated with a `Device`.
Parameters	`osid.id.Id`	`deviceId`	`Id` of the `Device`
Return	`osid.control.rules.DeviceEnablerList`		the device enablers
Errors	NOT_FOUND		`deviceId` is not found
	NULL_ARGUMENT		`deviceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeviceIdsForDeviceEnabler
Description	Gets the `Device` `Ids` mapped to a `DeviceEnabler`.
Parameters	`osid.id.Id`	`deviceEnablerId`	`Id` of a `DeviceEnabler`
Return	`osid.id.IdList`		list of device `Ids`
Errors	NOT_FOUND		`deviceEnablerId` is not found
	NULL_ARGUMENT		`deviceEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDevicesForDeviceEnabler
Description	Gets the `Devices` mapped to a `DeviceEnabler`.
Parameters	`osid.id.Id`	`deviceEnablerId`	`Id` of a `DeviceEnabler`
Return	`osid.control.DeviceList`		list of devices
Errors	NOT_FOUND		`deviceEnablerId` is not found
	NULL_ARGUMENT		`deviceEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.