Interface ProcedureBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProcedureAdminSession
public interface ProcedureBatchAdminSession extends ProcedureAdminSession

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

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

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

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

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

The delete operations delete Procedures in bulk. To unmap a Procedure from the current Cookbook , the ProcedureCookbookAssignmentSession should be used. These delete operations attempt to remove the Procedure itself thus removing it from all known Cookbook catalogs. Bulk delete operations return the results in DeleteResponses .