Interface ProcessBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProcessAdminSession
public interface ProcessBatchAdminSession extends ProcessAdminSession

This session creates, updates, and deletes Processes 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 Process , a ProcessForm is requested using getProcessFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned ProcessForms 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 ProcessForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ProcessForm corresponds to an attempted transaction.

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

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

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

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

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