Interface | osid.control.rules.DeviceEnablerSystemAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignDeviceEnablers | ||
Description |
Tests if this user can alter device enabler/system
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 | canAssignDeviceEnablersToSystem | ||
Description |
Tests if this user can alter device enabler/system
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
| ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | systemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableSystemIds | ||
Description |
Gets a list of systems including and under the given system node in which any device enabler can be assigned. | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.id.IdList | list of assignable system Ids | |
Errors | NULL_ARGUMENT | systemId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableSystemIdsForDeviceEnabler | ||
Description |
Gets a list of systems including and under the given system node in which a specific device enabler can be assigned. | ||
Parameters | osid.id.Id | systemId | the Id of the System |
osid.id.Id | deviceEnablerId | the Id of the DeviceEnabler | |
Return | osid.id.IdList | list of assignable system Ids | |
Errors | NULL_ARGUMENT | systemId or deviceEnablerId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignDeviceEnablerToSystem | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | deviceEnablerId | the Id of the DeviceEnabler |
osid.id.Id | systemId | the Id of the System | |
Errors | ALREADY_EXISTS | deviceEnablerId already assigned to systemId | |
NOT_FOUND | deviceEnablerId or systemId not found | ||
NULL_ARGUMENT | deviceEnablerId or systemId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignDeviceEnablerFromSystem | ||
Description |
Removes a | ||
Parameters | osid.id.Id | deviceEnablerId | the Id of the DeviceEnabler |
osid.id.Id | systemId | the Id of the System | |
Errors | NOT_FOUND | deviceEnablerId or systemId not found or
deviceEnablerId already assigned to systemId | |
NULL_ARGUMENT | deviceEnablerId or systemId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignDeviceEnablerToSystem | ||
Description |
Moves a | ||
Parameters | osid.id.Id | deviceEnablerId | the Id of the DeviceEnabler |
osid.id.Id | fromSystemId | the Id of the current System | |
osid.id.Id | toSystemId | the Id of the destination System | |
Errors | NOT_FOUND | deviceEnablerId, fromSystemId, or toSystemId
not found or deviceEnablerId not mapped to fromSystemId
| |
NULL_ARGUMENT | deviceEnablerId, fromSystemId, or toSystemrId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |