Interface | osid.control.rules.DeviceEnablerRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
Method | getSystemId | ||
Description |
Gets the | ||
Return | osid.id.Id | the System Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystem | ||
Description |
Gets the | ||
Return | osid.control.System | the system | |
Errors | OPERATION_FAILED | unable to complete request | |
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
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | assignDeviceEnablerToDevice | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | deviceEnablerId | the Id of the DeviceEnabler |
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 | ||
Parameters | osid.id.Id | deviceEnablerId | the Id of the DeviceEnabler |
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 | ||
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 |
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. |