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