Interface RequestBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RequestAdminSession
public interface RequestBatchAdminSession extends RequestAdminSession

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

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

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

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

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

The delete operations delete Requests in bulk. To unmap an Request 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 .