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