public interface EntryBatchAdminSession extends EntryAdminSession
This session creates, updates, and deletes Entries
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
Entry,
an EntryForm
is requested using
getEntryFormsForCreate()
specifying the desired entry slot,
period, record Types
or none if no record Types
are needed. Each of the returned EntryForms
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
EntryForm
is submiited to a create operation, it cannot be reused
with another create operation unless the first operation was unsuccessful.
Each EntryForm
corresponds to an attempted transaction.
The EntryForms
returned from
getEntryFormsForCreate()
may be linked to the originating request
through the peer Ids
of the EntryForm.
In
the case where there may be duplicates, any EntryForm
of
the same peer Ids
may be used for a create operation.
Once a batch of EntryForms
are submitted for create, a
CreateResponse
is returned for each EntryForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createEntries(),
errors specific to an individual EntryForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating EntryForm
through the EntryForm
Id
.
For updates, EntryForms
are requested to the
Entry
Id
that is to be updated using
getEntryFormsForUpdate()
where the reference Id
in
the EntryForm
may be used to link the request. Similarly,
the EntryForm
has metadata about the data that can be
updated and it can perform validation before submitting the update. The
EntryForm
can only be used once for a successful update and
cannot be reused.
Once a batch of EntryForms
are submitted for update, an
UpdateResponse
is returned for each EntryForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateEntries(),
errors specific to an individual EntryForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating EntryForm
through the EntryForm
Id.
The delete operations delete Entries
in bulk. To unmap
an Entry
from the current Business,
the
EntryBusinessAssignmentSession
should be used. These delete
operations attempt to remove the Entry
itself thus removing
it from all known Business
catalogs. Bulk delete operations
return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasEntries(AliasRequestList aliasRequests)
Adds an
Id to an Entry for the purpose
of creating compatibility. |
CreateResponseList |
createEntries(EntryBatchFormList entryForms)
Creates a new set of
Entries. |
DeleteResponseList |
deleteAllEntries()
Deletes all
Entries in this Business . |
DeleteResponseList |
deleteEntries(IdList entryIds)
Deletes entries for the given
Ids. |
DeleteResponseList |
deleteEntriesForCustomer(Id customerId)
Deletes entries for the given customer.
|
DeleteResponseList |
deleteEntriesForPeriod(Id periodId)
Deletes entries for the given period.
|
DeleteResponseList |
deleteIneffectiveEntriesByDate(DateTime date)
Deletes entries expired before the given date.
|
EntryBatchFormList |
getEntryFormsForCreate(EntryPeerList peers,
Type[] entryRecordTypes)
Gets the entry forms for creating a bunch of new entries.
|
EntryBatchFormList |
getEntryFormsForUpdate(IdList entryIds)
Gets the entry forms for updating an existing set of entries.
|
UpdateResponseList |
updateEntries(EntryBatchFormList entryForms)
Updates existing entries.
|
aliasEntry, canCreateEntries, canCreateEntryWithRecordTypes, canDeleteEntries, canManageEntryAliases, canUpdateEntries, createEntry, deleteEntry, getBusiness, getBusinessId, getEntryFormForCreate, getEntryFormForUpdate, updateEntry
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
EntryBatchFormList getEntryFormsForCreate(EntryPeerList peers, Type[] entryRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- the entry peersentryRecordTypes
- array of entry record types to be included in
each create operation or an empty list if noneNotFoundException
- a customerId, itemId,
or periodId
is not foundNullArgumentException
- peers
or
entryRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createEntries(EntryBatchFormList entryForms) throws OperationFailedException, PermissionDeniedException
Entries.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.entryForms
- the entry formsNullArgumentException
- entryForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EntryBatchFormList getEntryFormsForUpdate(IdList entryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
entryIds
- the Ids
of the Entry
NotFoundException
- an entryId
is not
foundNullArgumentException
- entryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateEntries(EntryBatchFormList entryForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.entryForms
- the form containing the elements to be updatedNullArgumentException
- entryForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllEntries() throws OperationFailedException, PermissionDeniedException
Entries
in this Business
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteEntries(IdList entryIds) throws OperationFailedException, PermissionDeniedException
Ids.
entryIds
- the Ids
of the entries to deleteNullArgumentException
- entryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteEntriesForCustomer(Id customerId) throws OperationFailedException, PermissionDeniedException
customerId
- an Id
of a customerNullArgumentException
- customerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteEntriesForPeriod(Id periodId) throws OperationFailedException, PermissionDeniedException
periodId
- an Id
of a periodNullArgumentException
- periodId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveEntriesByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasEntries(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an Entry
for the purpose
of creating compatibility. The primary Id
of the
Entry
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is a
pointer to another entry, it is reassigned to the given entry
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.