| Interface | osid.workflow.event.WorkflowEventOfficeAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.workflow.event.WorkflowEventManager | ||
osid.workflow.event.WorkflowEventProxyManager | |||
| Description |
This session provides methods to re-assign
Adding a reference of a | ||
| Method | canAssignWorkflowEvents | ||
| Description |
Tests if this user can alter workflow event/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 | canAssignWorkflowEventToOffice | ||
| Description |
Tests if this user can alter workflow event/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 offices including and under the given office node in which any workflow event 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 | getAssignableOfficeIdsForWorkflowEvent | ||
| Description |
Gets a list of offices including and under the given office node in which a specific workflow event can be assigned. | ||
| Parameters | osid.id.Id | officeId | the Id of the Office |
osid.id.Id | workflowEventId | the Id of the WorkflowEvent | |
| Return | osid.id.IdList | list of assignable office Ids | |
| Errors | NULL_ARGUMENT | officeId or workflowEventId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignWorkflowEventToOffice | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | workflowEventId | the Id of the WorkflowEvent |
osid.id.Id | officeId | the Id of the Office | |
| Errors | ALREADY_EXISTS | workflowEventId is already assigned to officeId | |
| NOT_FOUND | workflowEventId or officeId not found | ||
| NULL_ARGUMENT | workflowEventId or officeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignWorkflowEventFromOffice | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | workflowEventId | the Id of the WorkflowEvent |
osid.id.Id | officeId | the Id of the Office | |
| Errors | NOT_FOUND | workflowEventId or officeId not found or
workflowEventId not assigned to officeId | |
| NULL_ARGUMENT | workflowEventId or officeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignWorkflowEventToOffice | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | workflowEventId | the Id of the WorkflowEvent |
osid.id.Id | fromOfficeId | the Id of the current Office | |
osid.id.Id | toOfficeId | the Id of the destination Office | |
| Errors | ALREADY_EXISTS | workflowEventId already assigned to toofficeId | |
| NOT_FOUND | workflowEventId, fromOfficeId , or toOfficeeId
not found or workflowEventId not mapped to
fromOfficeId | ||
| NULL_ARGUMENT | workflowEventId, fromOfficeId , or toOfficeId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |