Interface StepBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, StepAdminSession
public interface StepBatchAdminSession extends StepAdminSession

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 .