| Interface | osid.workflow.rules.ProcessConstrainerOfficeAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.workflow.rules.WorkflowRulesManager | ||
osid.workflow.rules.WorkflowRulesProxyManager | |||
| Description |
This session provides methods to re-assign
Adding a reference of a | ||
| Method | canAssignProcessConstrainers | ||
| Description |
Tests if this user can alter process constrainer/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 | canAssignProcessConstrainerToOffice | ||
| Description |
Tests if this user can alter process constrainer/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 constrainer 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 | getAssignableOfficeIdsForProcessConstrainer | ||
| Description |
Gets a list of offices including and under the given office node in which a specific process constrainer can be assigned. | ||
| Parameters | osid.id.Id | officeId | the Id of the Office |
osid.id.Id | processConstrainerId | the Id of the ProcessConstrainer | |
| Return | osid.id.IdList | list of assignable office Ids | |
| Errors | NULL_ARGUMENT | officeId or processConstrainerId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignProcessConstrainerToOffice | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | processConstrainerId | the Id of the ProcessConstrainer |
osid.id.Id | officeId | the Id of the Office | |
| Errors | ALREADY_EXISTS | processConstrainerId is already assigned to
officeId | |
| NOT_FOUND | processConstrainerId or officeId not found | ||
| NULL_ARGUMENT | processConstrainerId or officeId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignProcessConstrainerFromOffice | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | processConstrainerId | the Id of the ProcessConstraienr |
osid.id.Id | officeId | the Id of the Office | |
| Errors | NOT_FOUND | processConstrainerId or officeId not found or
processConstrainerId not assigned to officeId | |
| NULL_ARGUMENT | processConstrainerId or officeId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignProcessConstrainerToOffice | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | processConstrainerId | the Id of the ProcessConstrainer |
osid.id.Id | fromOfficeId | the Id of the current Office | |
osid.id.Id | toOfficeId | the Id of the destination Office | |
| Errors | ALREADY_EXISTS | processConstrainerId already assigned to
toOfficeId | |
| NOT_FOUND | processConstrainerId, fromOfficeId , or
toOfficeId not found or processConstrainerId not
mapped to fromOfficeId | ||
| NULL_ARGUMENT | processConstrainerId, fromOfficeId , or
toOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |