org.osid.inventory.batch

Interface StockBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasStocks(AliasRequestList aliasRequests) Adds an Id to a Stock for the purpose of creating compatibility.
CreateResponseList	createStocks(StockBatchFormList stockForms) Creates a new set of Stocks.
DeleteResponseList	deleteAllStocks() Deletes all Stocks in this Inventory .
DeleteResponseList	deleteStocks(IdList stockIds) Deletes stocks for the given Ids.
StockBatchFormList	getStockFormsForCreate(long number, Type[] stockRecordTypes) Gets the stock forms for creating a bunch of new stocks.
StockBatchFormList	getStockFormsForUpdate(IdList stockIds) Gets the stock forms for updating an existing set of stocks.
UpdateResponseList	updateStocks(StockBatchFormList stockForms) Updates existing stocks.

Methods inherited from interface org.osid.inventory.StockAdminSession

aliasStock, canCreateStocks, canCreateStockWithRecordTypes, canDeleteStocks, canManageStockAliases, canUpdateStocks, createStock, deleteStock, getStockFormForCreate, getStockFormForUpdate, getWarehouse, getWarehouseId, updateStock

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getStockFormsForCreate

StockBatchFormList getStockFormsForCreate(long number,
                                        Type[] stockRecordTypes)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets the stock forms for creating a bunch of new stocks.

Parameters:

number - the number of forms to retrieve

stockRecordTypes - array of stock record types to be included in each create operation or an empty list if none

Returns:

the stock forms

Throws:

NullArgumentException - stockRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createStocks

CreateResponseList createStocks(StockBatchFormList stockForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

Creates a new set of Stocks. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

stockForms - the stock forms

Returns:

the create responses

Throws:

NullArgumentException - stockForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStockFormsForUpdate

StockBatchFormList getStockFormsForUpdate(IdList stockIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the stock forms for updating an existing set of stocks. A new stock form should be requested for each update transaction.

Parameters:

stockIds - the Ids of the Stock

Returns:

the stock form

Throws:

NotFoundException - a stockId is not found

NullArgumentException - stockIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateStocks

UpdateResponseList updateStocks(StockBatchFormList stockForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

Updates existing stocks. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

stockForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - stockForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllStocks

DeleteResponseList deleteAllStocks()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Stocks in this Inventory .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteStocks

DeleteResponseList deleteStocks(IdList stockIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes stocks for the given Ids.

Parameters:

stockIds - the Ids of the stocks to delete

Returns:

the delete responses

Throws:

NullArgumentException - stockIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasStocks

AliasResponseList aliasStocks(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

Adds an Id to a Stock for the purpose of creating compatibility. The primary Id of the Stock is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another stock, it is reassigned to the given stock Id.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.