Interface AuctionBatchAdminSession

All Superinterfaces:
AuctionAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AuctionBatchAdminSession extends AuctionAdminSession

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

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

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

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

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

The delete operations delete Auctions in bulk. To unmap an Auction from the current AuctionHouse , the AuctionAuctionHouseAssignmentSession should be used. These delete operations attempt to remove the Auction itself thus removing it from all known AuctionHouse catalogs. Bulk delete operations return the results in DeleteResponses .