| Interface | osid.ordering.batch.OrderItemBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.ordering.OrderItemAdminSession | ||
| Used By | osid.ordering.batch.OrderingBatchManager | ||
osid.ordering.batch.OrderingBatchProxyManager | |||
| Description |
This session creates, updates, and deletes
Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete Like all | ||
| Method | getOrderItemFormsForCreate | ||
| Description |
Gets the order item forms for creating a bunch of new order items. An OrderItemForm is returned for each order and product pair. | ||
| Parameters | osid.ordering.batch.OrderItemPeerList | peers | the relationship peers |
osid.type.Type[] | orderItemRecordTypes | array of order item record types to be included in each create operation or an empty list if none | |
| Return | osid.ordering.batch.OrderItemBatchFormList | the order item forms | |
| Errors | NOT_FOUND | an orderId or productId is not found | |
| NULL_ARGUMENT | peers or orderItemRecordTypes is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | unable to request forms with given record types | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | createOrderItems | ||
| Description |
Creates a new set of | ||
| Parameters | osid.ordering.batch.OrderItemBatchFormList | orderItemForms | the order item forms |
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT | orderItemForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrderItemFormsForUpdate | ||
| Description |
Gets the order item forms for updating an existing set of order items. A new order item form should be requested for each update transaction. | ||
| Parameters | osid.id.IdList | orderItemIds | the Ids of the OrderItem |
| Return | osid.ordering.batch.OrderItemBatchFormList | the order item form | |
| Errors | NOT_FOUND | an orderItemId is not found | |
| NULL_ARGUMENT | orderItemIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateOrderItems | ||
| Description |
Updates existing order items. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
| Parameters | osid.ordering.batch.OrderItemBatchFormList | orderItemForms | the form containing the elements to be updated |
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT | orderItemForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllOrderItems | ||
| Description |
Deletes all | ||
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteOrderItems | ||
| Description |
Deletes order items for the given | ||
| Parameters | osid.id.IdList | orderItemIds | the Ids of the order items to delete |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | orderItemIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteOrderItemsForProduct | ||
| Description |
Deletes all order items for the given product. | ||
| Parameters | osid.id.Id | productId | an Id of a product |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | productId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteOrderItemsForOrder | ||
| Description |
Deletes all order items for the given order. | ||
| Parameters | osid.id.Id | orderId | an Id of an order |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | orderId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveOrderItemsByDate | ||
| Description |
Deletes order items expired before the given date. | ||
| Parameters | osid.calendaring.DateTime | date | a date |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | date is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasOrderItems | ||
| Description |
Adds an | ||
| Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
| Return | osid.transaction.batch.AliasResponseList | the alias responses | |
| Errors | NULL_ARGUMENT | aliasRequests is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |