Interface AuctionHouseBatchAdminSession

All Superinterfaces:
AuctionHouseAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AuctionHouseBatchAdminSession extends AuctionHouseAdminSession

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

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

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

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

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

The delete operations delete AuctionHouses in bulk. Bulk delete operations return the results in DeleteResponses .