OSID Logo
OSID Specifications
billing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.batch.ItemBatchAdminSession
Implementsosid.billing.ItemAdminSession
Description

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

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

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

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

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

The delete operations delete Items in bulk. To unmap an Item from the current Business, the ItemBusinessAssignmentSession should be used. These delete operations attempt to remove the Item itself thus removing it from all known Business catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetItemFormsForCreate
Description

Gets the item forms for creating a bunch of new items.

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

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

Parametersosid.billing.batch.ItemBatchFormListitemFormsthe item forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT itemForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetItemFormsForUpdate
Description

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

Parametersosid.id.IdListitemIdsthe Ids of the Item
Returnosid.billing.batch.ItemBatchFormListthe item form
ErrorsNOT_FOUNDan itemId is not found
NULL_ARGUMENT itemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateItems
Description

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

Parametersosid.billing.batch.ItemBatchFormListitemFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT itemForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllItems
Description

Deletes all Items in this Business .

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

Deletes items for the given Ids.

Parametersosid.id.IdListitemIdsthe Ids of the items to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT itemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasItems
Description

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