Interface BidBatchAdminSession

All Superinterfaces:
AutoCloseable, BidAdminSession, Closeable, OsidSession, OsidSession
public interface BidBatchAdminSession extends BidAdminSession

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

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

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

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

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

The delete operations delete Bids in bulk. To unmap a Bid from the current AuctionHouse , the BidAuctionHouseAssignmentSession should be used. These delete operations attempt to remove the Bid itself thus removing it from all known AuctionHouse catalogs. Bulk delete operations return the results in DeleteResponses .