Interface CommissionBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CommissionAdminSession, OsidSession, OsidSession
public interface CommissionBatchAdminSession extends CommissionAdminSession

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

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

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

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

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

The delete operations delete Commissions in bulk. To unmap a Commission from the current Foundry , the CommissionFoundryAssignmentSession should be used. These delete operations attempt to remove the Commission itself thus removing it from all known Foundry catalogs. Bulk delete operations return the results in DeleteResponses .