public interface JournalBatchAdminSession extends JournalAdminSession
This session creates, updates, and deletes Journals
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
Journal,
a JournalForm
is requested using
getJournalFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed. Each
of the returned JournalForms
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 JournalForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
JournalForm
corresponds to an attempted transaction.
The JournalForms
returned from
getJournalFormsForCreate()
may be linked to the originating
request through the peer Ids
of the JournalForm.
In the case where there may be duplicates, any JournalForm
of the same peer Ids
may be used for a create
operation.
Once a batch of JournalForms
are submitted for create,
a CreateResponse
is returned for each JournalForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createJournals(),
errors specific to an individual JournalForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
JournalForm
through the JournalForm
Id
.
For updates, JournalForms
are requested to the
Journal
Id
that is to be updated using
getJournalFormsForUpdate()
where the reference Id
in the JournalForm
may be used to link the request.
Similarly, the JournalForm
has metadata about the data that
can be updated and it can perform validation before submitting the update.
The JournalForm
can only be used once for a successful
update and cannot be reused.
Once a batch of JournalForms
are submitted for update,
an UpdateResponse
is returned for each JournalForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateJournals(),
errors specific to an individual JournalForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating
JournalForm
through the JournalForm
Id.
The delete operations delete Journals
in bulk. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasJournals(AliasRequestList aliasRequests)
Adds an
Id to a Journal for the purpose
of creating compatibility. |
CreateResponseList |
createJournals(JournalBatchFormList journalForms)
Creates a new set of
Journals. |
DeleteResponseList |
deleteAllJournals()
Deletes all
Journals. |
DeleteResponseList |
deleteJournals(IdList journalIds)
Deletes journals for the given
Ids. |
JournalBatchFormList |
getJournalFormsForCreate(long number,
Type[] journalRecordTypes)
Gets the journal forms for creating a bunch of new journals.
|
JournalBatchFormList |
getJournalFormsForUpdate(IdList journalIds)
Gets the journal forms for updating an existing set of journals.
|
UpdateResponseList |
updateJournals(JournalBatchFormList journalForms)
Updates existing journals.
|
aliasJournal, canCreateJournals, canCreateJournalWithRecordTypes, canDeleteJournals, canManageJournalAliases, canUpdateJournals, createJournal, deleteJournal, getJournalFormForCreate, getJournalFormForUpdate, updateJournal
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
JournalBatchFormList getJournalFormsForCreate(long number, Type[] journalRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievejournalRecordTypes
- array of journal record types to be
included in each create operation or an empty list if noneNullArgumentException
- journalRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createJournals(JournalBatchFormList journalForms) throws OperationFailedException, PermissionDeniedException
Journals.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.journalForms
- the journal formsNullArgumentException
- journalForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JournalBatchFormList getJournalFormsForUpdate(IdList journalIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
journalIds
- the Ids
of the Journal
NotFoundException
- a journalId
is not
foundNullArgumentException
- journalIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateJournals(JournalBatchFormList journalForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.journalForms
- the form containing the elements to be updatedNullArgumentException
- journalForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllJournals() throws OperationFailedException, PermissionDeniedException
Journals.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteJournals(IdList journalIds) throws OperationFailedException, PermissionDeniedException
Ids.
journalIds
- the Ids
of the journals to deleteNullArgumentException
- journalIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasJournals(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Journal
for the purpose
of creating compatibility. The primary Id
of the
Journal
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is
a pointer to another journal, it is reassigned to the given journal
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.