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