| Interface | osid.workflow.rules.StepConstrainerOfficeAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session provides methods to re-assign   Adding a reference of a   | ||
| Method | canAssignStepConstrainers | ||
| Description | 
                     Tests if this user can alter step constrainer/office 
                    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 | canAssignStepConstrainersToOffice | ||
| Description | 
                     Tests if this user can alter step constrainer/office 
                    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 | officeId | the  Id  of the  Office   | 
| Return | boolean |  false  if mapping is not authorized,  true  
otherwise  | |
| Errors | NULL_ARGUMENT |  officeId  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableOfficeIds | ||
| Description | 
                     Gets a list of office including and under the given office node in which any step constrainer can be assigned.  | ||
| Parameters | osid.id.Id | officeId | the  Id  of the  Office   | 
| Return | osid.id.IdList | list of assignable office  Ids   | |
| Errors | NULL_ARGUMENT |  officeId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableOfficeIdsForStepConstrainer | ||
| Description | 
                     Gets a list of office including and under the given office node in which a specific step constrainer can be assigned.  | ||
| Parameters | osid.id.Id | officeId | the  Id  of the  Office   | 
osid.id.Id | stepConstrainerId | the  Id  of the  StepConstrainer   | |
| Return | osid.id.IdList | list of assignable office  Ids   | |
| Errors | NULL_ARGUMENT |  officeId  or  stepConstrainerId  is  null 
  |                 |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignStepConstrainerToOffice | ||
| Description | 
                     Adds an existing   | ||
| Parameters | osid.id.Id | stepConstrainerId | the  Id  of the  StepConstrainer   | 
osid.id.Id | officeId | the  Id  of the  Office   | |
| Errors | ALREADY_EXISTS |  stepConstrainerId  is already assigned to  officeId 
  |                 |
| NOT_FOUND |  stepConstrainerId  or  officeId  not found  |                 ||
| NULL_ARGUMENT |  stepConstrainerId  or  officeId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignStepConstrainerFromOffice | ||
| Description | 
                     Removes a   | ||
| Parameters | osid.id.Id | stepConstrainerId | the  Id  of the  StepConstrainer   | 
osid.id.Id | officeId | the  Id  of the  Office   | |
| Errors | NOT_FOUND |  stepConstrainerId  or  officeId  not found or 
 stepConstrainerId  not assigned to  officeId   |                 |
| NULL_ARGUMENT |  stepConstrainerId  or  officeId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignStepConstrainerToOffice | ||
| Description | 
                     Moves a   | ||
| Parameters | osid.id.Id | stepConstrainerId | the  Id  of the  StepConstrainer   | 
osid.id.Id | fromOfficeId | the  Id  of the current  Office   | |
osid.id.Id | toOfficeId | the  Id  of the destination  Office   | |
| Errors | NOT_FOUND |  stepConstrainerId, fromOfficeId,  or  toOfficeId 
 not found or  stepConstrainerId  not mapped to  
fromOfficeId   |                 |
| NULL_ARGUMENT |  stepConstrainerId, fromOfficeId,  or  toOfficeId 
 is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |