OSID Logo
OSID Specifications
inventory batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.batch.StockBatchAdminSession
Implementsosid.inventory.StockAdminSession
Description

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.

MethodgetStockFormsForCreate
Description

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

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]stockRecordTypesarray of stock record types to be included in each create operation or an empty list if none
Returnosid.inventory.batch.StockBatchFormListthe stock forms
ErrorsNULL_ARGUMENT stockRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateStocks
Description

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 .

Parametersosid.inventory.batch.StockBatchFormListstockFormsthe stock forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT stockForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStockFormsForUpdate
Description

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

Parametersosid.id.IdListstockIdsthe Ids of the Stock
Returnosid.inventory.batch.StockBatchFormListthe stock form
ErrorsNOT_FOUNDa stockId is not found
NULL_ARGUMENT stockIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateStocks
Description

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 .

Parametersosid.inventory.batch.StockBatchFormListstockFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT stockForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllStocks
Description

Deletes all Stocks in this Inventory .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteStocks
Description

Deletes stocks for the given Ids.

Parametersosid.id.IdListstockIdsthe Ids of the stocks to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT stockIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasStocks
Description

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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.