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.
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.
|
aliasItem, canCreateItems, canCreateItemWithRecordTypes, canDeleteItems, canManageItemAliases, canUpdateItems, createItem, deleteItem, getItemFormForCreate, getItemFormForUpdate, getStore, getStoreId, updateItem
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ItemBatchFormList getItemFormsForCreate(ItemPeerList peers, Type[] itemRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- the relationship peersitemRecordTypes
- array of item record types to be included in
each create operation or an empty list if noneNotFoundException
- an effortId
or
resourceId
is not foundNullArgumentException
- peers
or
itemRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createItems(ItemBatchFormList itemForms) throws OperationFailedException, PermissionDeniedException
Items.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.itemForms
- the item formsNullArgumentException
- itemForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ItemBatchFormList getItemFormsForUpdate(IdList itemIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
itemIds
- the Ids
of the Item
NotFoundException
- an itemId
is not
foundNullArgumentException
- itemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateItems(ItemBatchFormList itemForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.itemForms
- the form containing the elements to be updatedNullArgumentException
- itemForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllItems() throws OperationFailedException, PermissionDeniedException
Items
in this Store
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteItems(IdList itemIds) throws OperationFailedException, PermissionDeniedException
Ids.
itemIds
- the Ids
of the items to deleteNullArgumentException
- itemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteItemsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- an Id
of a resourceNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteItemsForOrder(Id orderId) throws OperationFailedException, PermissionDeniedException
orderId
- an Id
of an orderNullArgumentException
- orderId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveItemsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasItems(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.