| Interface | osid.workflow.rules.StepProcessorOfficeAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignStepProcessors | ||
| Description |
Tests if this user can alter step processor/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 | canAssignStepProcessorsToOffice | ||
| Description |
Tests if this user can alter step processor/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 processor 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 | getAssignableOfficeIdsForStepProcessor | ||
| Description |
Gets a list of office including and under the given office node in which a specific step processor can be assigned. | ||
| Parameters | osid.id.Id | officeId | the Id of the Office |
osid.id.Id | stepProcessorId | the Id of the StepProcessor | |
| Return | osid.id.IdList | list of assignable office Ids | |
| Errors | NULL_ARGUMENT | officeId or stepProcessorId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignStepProcessorToOffice | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | stepProcessorId | the Id of the StepProcessor |
osid.id.Id | officeId | the Id of the Office | |
| Errors | ALREADY_EXISTS | stepProcessorId is already assigned to officeId
| |
| NOT_FOUND | stepProcessorId or officeId not found | ||
| NULL_ARGUMENT | stepProcessorId or officeId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignStepProcessorFromOffice | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | stepProcessorId | the Id of the StepProcessor |
osid.id.Id | officeId | the Id of the Office | |
| Errors | NOT_FOUND | stepProcessorId or officeId not found or
stepProcessorId not assigned to officeId | |
| NULL_ARGUMENT | stepProcessorId or officeId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignStepProcessorToOffice | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | stepProcessorId | the Id of the StepProcessor |
osid.id.Id | fromOfficeId | the Id of the current Office | |
osid.id.Id | toOfficeId | the Id of the destination Office | |
| Errors | NOT_FOUND | stepProcessorId, fromOfficeId, or toOfficeId
not found or stepProcessorId not mapped to fromOfficeId
| |
| NULL_ARGUMENT | stepProcessorId, fromOfficeId, or toOfficeId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |