OSID Logo
OSID Specifications
workflow batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.batch.StepBatchAdminSession
Implementsosid.workflow.StepAdminSession
Description

This session creates, updates, and deletes Steps in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Step, a StepForm is requested using getStepFormsForCreate() specifying the process and desired record Types or none if no record Types are needed. Each of the returned StepForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a StepForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each StepForm corresponds to an attempted transaction.

The StepForms returned from getStepFormsForCreate() may be linked to the originating request through the peer Ids of the StepForm. In the case where there may be duplicates, any StepForm of the same peer Ids may be used for a create operation.

Once a batch of StepForms are submitted for create, a CreateResponse is returned for each StepForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createSteps(), errors specific to an individual StepForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating StepForm through the StepForm Id .

For updates, StepForms are requested to the Step Id that is to be updated using getStepFormsForUpdate() where the reference Id in the StepForm may be used to link the request. Similarly, the StepForm has metadata about the data that can be updated and it can perform validation before submitting the update. The StepForm can only be used once for a successful update and cannot be reused.

Once a batch of StepForms are submitted for update, an UpdateResponse is returned for each StepForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateSteps(), errors specific to an individual StepForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating StepForm through the StepForm Id.

The delete operations delete Steps in bulk. To unmap a Step from the current Office, the StepOfficeAssignmentSession should be used. These delete operations attempt to remove the Step itself thus removing it from all known Office catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetStepFormsForCreate
Description

Gets the step forms for creating a bunch of new steps. A StepForm is returned for each supplied process Id.

Parametersosid.id.IdListprocessIdsan Id of a process
osid.type.Type[]stepRecordTypesarray of step record types to be included in each create operation or an empty list if none
Returnosid.workflow.batch.StepBatchFormListthe step forms
ErrorsNOT_FOUNDa processId is not found
NULL_ARGUMENT processId or stepRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateSteps
Description

Creates a new set of Steps. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.workflow.batch.StepBatchFormListstepFormsthe step forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT stepForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepFormsForUpdate
Description

Gets the step forms for updating an existing set of steps. A new step form should be requested for each update transaction.

Parametersosid.id.IdListstepIdsthe Ids of the Step
Returnosid.workflow.batch.StepBatchFormListthe step form
ErrorsNOT_FOUNDa stepId is not found
NULL_ARGUMENT stepIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateSteps
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 BatchCreateResponse .

Parametersosid.workflow.batch.StepBatchFormListstepFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT stepForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllSteps
Description

Deletes all Steps in this Office .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteSteps
Description

Deletes steps for the given Ids.

Parametersosid.id.IdListstepIdsthe Ids of the steps to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT stepIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteStepsForProcess
Description

Deletes all steps for the given process.

Parametersosid.id.IdprocessIdan Id of a process
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasSteps
Description

Adds an Id to a Step for the purpose of creating compatibility. The primary Id of the Step is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another step, it is reassigned to the given step Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.