OSID Logo
OSID Specifications
ordering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.batch.OrderBatchAdminSession
Implementsosid.ordering.OrderAdminSession
Description

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

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

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

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

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

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

MethodgetOrderFormsForCreate
Description

Gets the order forms for creating a bunch of new orders.

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

Creates a new set of Orders. 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.OrderBatchFormListorderFormsthe order forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT orderForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOrderFormsForUpdate
Description

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

Parametersosid.id.IdListorderIdsthe Ids of the Order
Returnosid.ordering.batch.OrderBatchFormListthe order form
ErrorsNOT_FOUNDa orderId is not found
NULL_ARGUMENT orderIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateOrders
Description

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

Deletes all Orders in this Store .

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

Deletes orders for the given Ids.

Parametersosid.id.IdListorderIdsthe Ids of the orders to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT orderIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasOrders
Description

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