public interface OrderBatchAdminSession extends OrderAdminSession
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.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasOrders(AliasRequestList aliasRequests)
Adds an
Id to a Order for the purpose of
creating compatibility. |
CreateResponseList |
createOrders(OrderBatchFormList orderForms)
Creates a new set of
Orders. |
DeleteResponseList |
deleteAllOrders()
Deletes all
Orders in this Store . |
DeleteResponseList |
deleteOrders(IdList orderIds)
Deletes orders for the given
Ids. |
OrderBatchFormList |
getOrderFormsForCreate(long number,
Type[] orderRecordTypes)
Gets the order forms for creating a bunch of new orders.
|
OrderBatchFormList |
getOrderFormsForUpdate(IdList orderIds)
Gets the order forms for updating an existing set of orders.
|
UpdateResponseList |
updateOrders(OrderBatchFormList orderForms)
Updates existing orders.
|
aliasOrder, canCreateOrders, canCreateOrderWithRecordTypes, canDeleteOrders, canManageOrderAliases, canUpdateOrders, createOrder, deleteOrder, getOrderFormForCreate, getOrderFormForUpdate, getStore, getStoreId, updateOrder
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
OrderBatchFormList getOrderFormsForCreate(long number, Type[] orderRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveorderRecordTypes
- array of order record types to be included in
each create operation or an empty list if noneNullArgumentException
- orderRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createOrders(OrderBatchFormList orderForms) throws OperationFailedException, PermissionDeniedException
Orders.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.orderForms
- the order formsNullArgumentException
- orderForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OrderBatchFormList getOrderFormsForUpdate(IdList orderIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
orderIds
- the Ids
of the Order
NotFoundException
- a orderId
is not
foundNullArgumentException
- orderIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateOrders(OrderBatchFormList orderForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.orderForms
- the form containing the elements to be updatedNullArgumentException
- orderForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllOrders() throws OperationFailedException, PermissionDeniedException
Orders
in this Store
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteOrders(IdList orderIds) throws OperationFailedException, PermissionDeniedException
Ids.
orderIds
- the Ids
of the orders to deleteNullArgumentException
- orderIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasOrders(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.