Interface StockBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, StockAdminSession
public interface StockBatchAdminSession extends StockAdminSession

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

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

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

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

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

The delete operations delete Stocks in bulk. To unmap a Stock from the current Inventory , the StockInventoryAssignmentSession should be used. These delete operations attempt to remove the Stock itself thus removing it from all known Inventory catalogs. Bulk delete operations return the results in DeleteResponses .