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