| Interface | osid.control.InputSystemAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignInputs | ||
| Description |
Tests if this user can alter input/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 input assignment is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignInputsToSystem | ||
| Description |
Tests if this user can alter input/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 input assignment 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 input 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 | getAssignableSystemIdsForInput | ||
| Description |
Gets a list of systems including and under the given system node in which a specific input can be assigned. | ||
| Parameters | osid.id.Id | systemId | the Id of the System |
osid.id.Id | inputId | the Id of the Input | |
| Return | osid.id.IdList | list of assignable system Ids | |
| Errors | NULL_ARGUMENT | systemId or inputId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignInputToSystem | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | inputId | the Id of the Input |
osid.id.Id | systemId | the Id of the System | |
| Errors | ALREADY_EXISTS | inputId is already assigned to systemId | |
| NOT_FOUND | inputId or systemId not found | ||
| NULL_ARGUMENT | inputId or systemId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignInputFromSystem | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | inputId | the Id of the Input |
osid.id.Id | systemId | the Id of the System | |
| Errors | NOT_FOUND | inputId or systemId not found or
inputId not assigned to systemId | |
| NULL_ARGUMENT | inputId or systemId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignInputToSystem | ||
| Description |
Moves an | ||
| Parameters | osid.id.Id | inputId | the Id of the Input |
osid.id.Id | fromSystemId | the Id of the current System | |
osid.id.Id | toSystemId | the Id of the destination System | |
| Errors | NOT_FOUND | inputId, fromSystemId, or toSystemId not
found or inputId not mapped to fromSystemId | |
| NULL_ARGUMENT | inputId, fromSystemId, or toSystemId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |