Interface RequestTransactionBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RequestTransactionAdminSession
public interface RequestTransactionBatchAdminSession extends RequestTransactionAdminSession

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

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

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

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

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

The delete operations delete RequestTransactions in bulk. To unmap a RequestTransaction from the current Distributor , the RequestDistributorAssignmentSession should be used. These delete operations attempt to remove the Request itself thus removing it from all known Distributor catalogs. Bulk delete operations return the results in DeleteResponses .