| Interface | osid.control.rules.InputEnablerSystemAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session provides methods to re-assign   Adding a reference of an   | ||
| Method | canAssignInputEnablers | ||
| Description | 
                     Tests if this user can alter input 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 | canAssignInputEnablersToSystem | ||
| Description | 
                     Tests if this user can alter input 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 input enabler can be assigned.  | ||
| Parameters | osid.id.Id | systemId | the  Id  of the  Syestem   | 
| 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 | getAssignableSystemIdsForInputEnabler | ||
| Description | 
                     Gets a list of systems including and under the given system node in which a specific input enabler can be assigned.  | ||
| Parameters | osid.id.Id | systemId | the  Id  of the  System   | 
osid.id.Id | inputEnablerId | the  Id  of the  InputEnabler   | |
| Return | osid.id.IdList | list of assignable system  Ids   | |
| Errors | NULL_ARGUMENT |  systemId  or  inputEnablerId  is  null 
  |                 |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignInputEnablerToSystem | ||
| Description | 
                     Adds an existing   | ||
| Parameters | osid.id.Id | inputEnablerId | the  Id  of the  InputEnabler   | 
osid.id.Id | systemId | the  Id  of the  System   | |
| Errors | ALREADY_EXISTS |  inputEnablerId  already assigned to  systemId   |                 |
| NOT_FOUND |  inputEnablerId  or  systemId  not found  |                 ||
| NULL_ARGUMENT |  inputEnablerId  or  systemId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignInputEnablerFromSystem | ||
| Description | 
                     Removes an   | ||
| Parameters | osid.id.Id | inputEnablerId | the  Id  of the  InputEnabler   | 
osid.id.Id | systemId | the  Id  of the  System   | |
| Errors | NOT_FOUND |  inputEnablerId  or  systemId  not found or 
 inputEnablerId  not assigned to  systemId   |                 |
| NULL_ARGUMENT |  inputEnablerId  or  systemId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignInputEnablerToSystem | ||
| Description | 
                     Moves an   | ||
| Parameters | osid.id.Id | inputEnablerId | the  Id  of the  InputEnabler   | 
osid.id.Id | fromSystemId | the  Id  of the current  System   | |
osid.id.Id | toSystemId | the  Id  of the destination  System   | |
| Errors | NOT_FOUND |  inputEnablerId, fromSystemId,  or  toSystemId  
not found or  inputEnablerId  not mapped to  fromSystemId 
  |                 |
| NULL_ARGUMENT |  inputEnablerId, fromSystemId,  or  toSystemId  
is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |