Interface | osid.workflow.StepAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | getOfficeId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Office Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOffice | ||
Description |
Gets the | ||
Return | osid.workflow.Office | the office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateSteps | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Step creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateStepWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | stepRecordTypes | array of step record types |
Return | boolean | true if Step creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | stepRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepFormForCreate | ||
Description |
Gets the step form for creating new steps. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | processId | a process Id |
osid.type.Type[] | stepRecordTypes | array of step record types | |
Return | osid.workflow.StepForm | the step form | |
Errors | NOT_FOUND | processId is not found | |
NULL_ARGUMENT | processId or stepRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createStep | ||
Description |
Creates a new | ||
Parameters | osid.workflow.StepForm | stepForm | the form for this Step |
Return | osid.workflow.Step | the new Step | |
Errors | ILLEGAL_STATE | stepForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | stepForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | stepForm did not originate from
getStepFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateSteps | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Step modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepFormForUpdate | ||
Description |
Gets the step form for updating an existing step. A new step form should be requested for each update transaction. | ||
Parameters | osid.id.Id | stepId | the Id of the Step |
Return | osid.workflow.StepForm | the step form | |
Errors | NOT_FOUND | stepId is not found | |
NULL_ARGUMENT | stepId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateStep | ||
Description |
Updates an existing step. | ||
Parameters | osid.workflow.StepForm | stepForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | stepForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | stepForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | stepForm did not originate from
getStepFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteSteps | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Step deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteStep | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | stepId | the Id of the Step to remove |
Errors | NOT_FOUND | stepId not found | |
NULL_ARGUMENT | stepId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageStepAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Step aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasStep | ||
Description |
Adds an | ||
Parameters | osid.id.Id | stepId | the Id of a Step |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | stepId not found | ||
NULL_ARGUMENT | stepId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |