Interface FunctionBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, FunctionAdminSession, OsidSession, OsidSession
public interface FunctionBatchAdminSession extends FunctionAdminSession

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

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

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

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

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

The delete operations delete Functions in bulk. To unmap a Function from the current Vault , the FunctionVaultAssignmentSession should be used. These delete operations attempt to remove the Function itself thus removing it from all known Vault catalogs. Bulk delete operations return the results in DeleteResponses .