org.osid.ordering.batch

Interface ItemBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ItemAdminSession, OsidSession

public interface ItemBatchAdminSession
extends ItemAdminSession

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 order, resource, and 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 Store, the ItemStoreAssignmentSession should be used. These delete operations attempt to remove the Item itself thus removing it from all known Store catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasItems(AliasRequestList aliasRequests) Adds an Id to an Item for the purpose of creating compatibility.
CreateResponseList	createItems(ItemBatchFormList itemForms) Creates a new set of Items.
DeleteResponseList	deleteAllItems() Deletes all Items in this Store .
DeleteResponseList	deleteIneffectiveItemsByDate(DateTime date) Deletes items expired before the given date.
DeleteResponseList	deleteItems(IdList itemIds) Deletes items for the given Ids.
DeleteResponseList	deleteItemsForOrder(Id orderId) Deletes all items for the given order.
DeleteResponseList	deleteItemsForResource(Id resourceId) Deletes all items for the given resource.
ItemBatchFormList	getItemFormsForCreate(ItemPeerList peers, Type[] itemRecordTypes) Gets the item forms for creating a bunch of new items.
ItemBatchFormList	getItemFormsForUpdate(IdList itemIds) Gets the item forms for updating an existing set of items.
UpdateResponseList	updateItems(ItemBatchFormList itemForms) Updates existing items.

Methods inherited from interface org.osid.ordering.ItemAdminSession

aliasItem, canCreateItems, canCreateItemWithRecordTypes, canDeleteItems, canManageItemAliases, canUpdateItems, createItem, deleteItem, getItemFormForCreate, getItemFormForUpdate, getStore, getStoreId, updateItem

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getItemFormsForCreate

ItemBatchFormList getItemFormsForCreate(ItemPeerList peers,
                                      Type[] itemRecordTypes)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the item forms for creating a bunch of new items. An ItemForm is returned for each order and resource pair.

Parameters:

peers - the relationship peers

itemRecordTypes - array of item record types to be included in each create operation or an empty list if none

Returns:

the item forms

Throws:

NotFoundException - an effortId or resourceId is not found

NullArgumentException - peers or itemRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createItems

CreateResponseList createItems(ItemBatchFormList itemForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 .

Parameters:

itemForms - the item forms

Returns:

the create responses

Throws:

NullArgumentException - itemForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getItemFormsForUpdate

ItemBatchFormList getItemFormsForUpdate(IdList itemIds)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

itemIds - the Ids of the Item

Returns:

the item form

Throws:

NotFoundException - an itemId is not found

NullArgumentException - itemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateItems

UpdateResponseList updateItems(ItemBatchFormList itemForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 .

Parameters:

itemForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - itemForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllItems

DeleteResponseList deleteAllItems()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes all Items in this Store .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteItems

DeleteResponseList deleteItems(IdList itemIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

Deletes items for the given Ids.

Parameters:

itemIds - the Ids of the items to delete

Returns:

the delete responses

Throws:

NullArgumentException - itemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteItemsForResource

DeleteResponseList deleteItemsForResource(Id resourceId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes all items for the given resource.

Parameters:

resourceId - an Id of a resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteItemsForOrder

DeleteResponseList deleteItemsForOrder(Id orderId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes all items for the given order.

Parameters:

orderId - an Id of an order

Returns:

the delete responses

Throws:

NullArgumentException - orderId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveItemsByDate

DeleteResponseList deleteIneffectiveItemsByDate(DateTime date)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Deletes items expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasItems

AliasResponseList aliasItems(AliasRequestList aliasRequests)
                             throws OperationFailedException,
                                    PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.