Interface JournalBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, JournalAdminSession, OsidSession, OsidSession
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 .