OSID Logo
OSID Specifications
ordering batch package
Version 3.1.0
Interfaceosid.ordering.batch.ProductBatchAdminSession
Implementsosid.ordering.ProductAdminSession
Used Byosid.ordering.batch.OrderingBatchManager
osid.ordering.batch.OrderingBatchProxyManager
Description

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

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

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

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

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

The delete operations delete Products in bulk. To unmap a Product from the current Store, the ProductStoreAssignmentSession should be used. These delete operations attempt to remove the Product itself thus removing it from all known Store catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetProductFormsForCreate
Description

Gets the product forms for creating a bunch of new products

Parameterscardinalnumber the number of forms to retrieve
osid.type.Type[]productRecordTypes array of product record types to be included in each create operation or an empty list if none
Returnosid.ordering.batch.ProductBatchFormList the product forms
ErrorsNULL_ARGUMENT productRecordTypes is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED unable to request forms with given record types
Compliancemandatory This method must be implemented.
MethodcreateProducts
Description

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

Parametersosid.ordering.batch.ProductBatchFormListproductForms the product forms
Returnosid.transaction.batch.CreateResponseList the create responses
ErrorsNULL_ARGUMENT productForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetProductFormsForUpdate
Description

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

Parametersosid.id.IdListproductIds the Ids of the Product
Returnosid.ordering.batch.ProductBatchFormList the product form
ErrorsNOT_FOUND a productId is not found
NULL_ARGUMENT productIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodupdateProducts
Description

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

Parametersosid.ordering.batch.ProductBatchFormListproductForms the form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseList the update responses
ErrorsNULL_ARGUMENT productForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteAllProducts
Description

Deletes all Products in this Store.

Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteProducts
Description

Deletes products for the given Ids.

Parametersosid.id.IdListproductIds the Ids of the products to delete
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT productIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodaliasProducts
Description

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

Parametersosid.transaction.batch.AliasRequestListaliasRequests the alias requests
Returnosid.transaction.batch.AliasResponseList the alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.