| Interface | osid.workflow.rules.StepConstrainerEnablerOfficeAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignStepConstrainerEnablers | ||
| Description |
Tests if this user can alter step constrainer
enabler/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 | canAssignStepConstrainerEnablersToOffice | ||
| Description |
Tests if this user can alter step constrainer
enabler/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 office including and under the given office node in which any step constrainer enabler 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 | getAssignableOfficeIdsForStepConstrainerEnabler | ||
| Description |
Gets a list of office including and under the given office node in which a specific step constrainer enabler can be assigned. | ||
| Parameters | osid.id.Id | officeId | the Id of the Office |
osid.id.Id | stepConstrainerEnablerId | the Id of the StepConstrainerEnabler | |
| Return | osid.id.IdList | list of assignable office Ids | |
| Errors | NULL_ARGUMENT | officeId or stepConstrainerEnablerId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignStepConstrainerEnablerToOffice | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | stepConstrainerEnablerId | the Id of the StepConstrainerEnabler |
osid.id.Id | officeId | the Id of the Office | |
| Errors | ALREADY_EXISTS | stepConstrainerEnablerId is already assigned to
officeId | |
| NOT_FOUND | stepConstrainerEnablerId or officeId not
found | ||
| NULL_ARGUMENT | stepConstrainerEnablerId or officeId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignStepConstrainerEnablerFromOffice | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | stepConstrainerEnablerId | the Id of the StepConstrainerEnabler |
osid.id.Id | officeId | the Id of the Office | |
| Errors | NOT_FOUND | stepConstrainerEnablerId or officeId not
found or stepConstrainerEnablerId not assigned to
officeId | |
| NULL_ARGUMENT | stepConstrainerEnablerId or officeId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignStepConstrainerEnablerToOffice | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | stepConstrainerEnablerId | the Id of the StepConstrainerEnabler |
osid.id.Id | fromOfficeId | the Id of the current Office | |
osid.id.Id | toOfficeId | the Id of the destination Office | |
| Errors | NOT_FOUND | stepConstrainerEnablerId, fromOfficeId, or toOfficeId
not found or stepConstrainerEnablerId not mapped to
fromOfficeId | |
| NULL_ARGUMENT | stepConstrainerEnablerId, fromOfficeId, or toOfficeId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |