OSID Logo
OSID Specifications
inventory batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.batch.InventoryBatchAdminSession
Implementsosid.inventory.InventoryAdminSession
Description

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

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

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

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

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

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

MethodgetInventoryFormsForCreate
Description

Gets the inventory forms for creating a bunch of new inventories.

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

Creates a new set of Inventories. 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.InventoryBatchFormListinventoryFormsthe inventory forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT inventoryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInventoryFormsForUpdate
Description

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

Parametersosid.id.IdListinventoryIdsthe Ids of the Inventory
Returnosid.inventory.batch.InventoryBatchFormListthe inventory form
ErrorsNOT_FOUNDan inventoryId is not found
NULL_ARGUMENT inventoryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateInventories
Description

Updates existing inventories. 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.InventoryBatchFormListinventoryFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT inventoryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllInventories
Description

Deletes all Inventories.

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

Deletes inventories for the given Ids.

Parametersosid.id.IdListinventoryIdsthe Ids of the inventories to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT inventoryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasInventories
Description

Adds an Id to an Inventory for the purpose of creating compatibility. The primary Id of the Inventory is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another inventory, it is reassigned to the given inventory 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.