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

Interface	osid.control.rules.DeviceEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.control.rules.ControlRulesManager`
Used By	`osid.control.rules.ControlRulesProxyManager`
Description	This session provides methods to apply `DeviceEnablers` to `Devices`. A `Device` with multiple `DeviceEnablers` means any positive rule evaluation across the enablers result in an active `Device`.
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	canAssignDeviceEnablers
Description	Tests if this user can alter device enabler/device mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignDeviceEnablerToDevice
Description	Adds an existing `DeviceEnabler` to a `Device`.
Parameters	`osid.id.Id`	`deviceEnablerId`	the `Id` of the `DeviceEnabler`
Parameters	`osid.id.Id`	`deviceId`	the `Id` of the `Device`
Errors	ALREADY_EXISTS		`deviceEnablerId` already applied to `deviceId`
	NOT_FOUND		`deviceEnablerId` or `deviceId` not found
	NULL_ARGUMENT		`deviceEnablerId` or `deviceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignDeviceEnablerFromDevice
Description	Removes a `DeviceEnabler` from a `Device`.
Parameters	`osid.id.Id`	`deviceEnablerId`	the `Id` of the `DeviceEnabler`
Parameters	`osid.id.Id`	`deviceId`	the `Id` of the `Device`
Errors	NOT_FOUND		`deviceEnablerId` or `deviceId` not found or `deviceEnablerId` not applied to `deviceId`
	NULL_ARGUMENT		`deviceEnablerId` or `deviceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceDeviceEnablers
Description	Tests if this user can order `DeviceEnablers`. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `DeviceEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveDeviceEnablerAhead
Description	Reorders device enablers for a device by moving the specified device enabler in front of a reference device enabler.
Parameters	`osid.id.Id`	`deviceEnablerId`	the `Id` of a `DeviceEnabler`
	`osid.id.Id`	`deviceId`	the `Id` of a `Device`
	`osid.id.Id`	`referenceId`	the reference device enabler `Id`
Errors	NOT_FOUND		`deviceEnablerId, deviceId`, or `referenceId` not found or, `deviceEnablerId` or `referenceId` not related to `deviceId`
	NULL_ARGUMENT		`deviceEnablerId, deviceId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveDeviceEnablerBehind
Description	Reorders device enablers for a device by moving the specified device enabler behind a reference device enabler.
Parameters	`osid.id.Id`	`deviceEnablerId`	the `Id` of a `DeviceEnabler`
	`osid.id.Id`	`deviceId`	the `Id` of a `Device`
	`osid.id.Id`	`referenceId`	the reference device enabler `Id`
Errors	NOT_FOUND		`deviceEnablerId, deviceId`, or `referenceId` not found or, `deviceEnablerId` or `referenceId` not related to `deviceId`
	NULL_ARGUMENT		`deviceEnablerId, deviceId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderDeviceEnablers
Description	Reorders a set of device enablers for a device.
Parameters	`osid.id.Id[]`	`deviceEnablerIds`	the `Ids` for a set of `DeviceEnablers`
Parameters	`osid.id.Id`	`deviceId`	the `Id` of a `Device`
Errors	NOT_FOUND		`deviceConstraienrId` not found or, a `deviceEnablerId` not related to `deviceId`
	NULL_ARGUMENT		`deviceEnablerIds` or `deviceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.