Interface | osid.workflow.ProcessOfficeAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignProcesses | ||
Description |
Tests if this user can alter process/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 | canAssignProcessesToOffice | ||
Description |
Tests if this user can alter process/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 process 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 | getAssignableOfficeIdsForProcess | ||
Description |
Gets a list of offices including and under the given office node in which a specific process can be assigned. | ||
Parameters | osid.id.Id | officeId | the Id of the Office |
osid.id.Id | processId | the Id of the Process | |
Return | osid.id.IdList | list of assignable office Ids | |
Errors | NULL_ARGUMENT | officeId or processId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignProcessToOffice | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | processId | the Id of the Process |
osid.id.Id | officeId | the Id of the Office | |
Errors | ALREADY_EXISTS | processId is already assigned to officeId | |
NOT_FOUND | processId or officeId not found | ||
NULL_ARGUMENT | processId or officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignProcessFromOffice | ||
Description |
Removes a | ||
Parameters | osid.id.Id | processId | the Id of the Process |
osid.id.Id | officeId | the Id of the Office | |
Errors | NOT_FOUND | processId or officeId not found or
processId is not assigned to officeId | |
NULL_ARGUMENT | processId or officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |