Interface | osid.workflow.batch.StepBatchAdminSession | ||
---|---|---|---|
Implements | osid.workflow.StepAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getStepFormsForCreate | ||
Description |
Gets the step forms for creating a bunch of new steps.
A StepForm is returned for each supplied process | ||
Parameters | osid.id.IdList | processIds | an Id of a process |
osid.type.Type[] | stepRecordTypes | array of step record types to be included in each create operation or an empty list if none | |
Return | osid.workflow.batch.StepBatchFormList | the step forms | |
Errors | NOT_FOUND | a processId is not found | |
NULL_ARGUMENT | processId or stepRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createSteps | ||
Description |
Creates a new set of | ||
Parameters | osid.workflow.batch.StepBatchFormList | stepForms | the step forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | stepForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepFormsForUpdate | ||
Description |
Gets the step forms for updating an existing set of steps. A new step form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | stepIds | the Ids of the Step |
Return | osid.workflow.batch.StepBatchFormList | the step form | |
Errors | NOT_FOUND | a stepId is not found | |
NULL_ARGUMENT | stepIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateSteps | ||
Description |
Updates existing steps. This method returns an error if
the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.workflow.batch.StepBatchFormList | stepForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | stepForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllSteps | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteSteps | ||
Description |
Deletes steps for the given | ||
Parameters | osid.id.IdList | stepIds | the Ids of the steps to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | stepIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteStepsForProcess | ||
Description |
Deletes all steps for the given process. | ||
Parameters | osid.id.Id | processId | an Id of a process |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | processId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasSteps | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |