Interface JournalEntryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, JournalEntryAdminSession, OsidSession, OsidSession
public interface JournalEntryBatchAdminSession extends JournalEntryAdminSession

This session creates, updates, and deletes JournalEntries 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 JournalEntry , a JournalEntryForm is requested using getJournalEntryFormsForCreate() specifying the desired branch, source, and record Types or none if no record Types are needed. Each of the returned JournalEntryForms 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 JournalEntryForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each JournalEntryForm corresponds to an attempted transaction.

The JournalEntryForms returned from getJournalEntryFormsForCreate() may be linked to the originating request through the peer Ids of the JournalEntryForm . In the case where there may be duplicates, any JournalEntryForm of the same peer Ids may be used for a create operation.

Once a batch of JournalEntryForms are submitted for create, a CreateResponse is returned for each JournalEntryForm , although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createJournalEntries() , errors specific to an individual JournalEntryForm are indicated in the corresponding CreateResponse . CreateResponses may be linked to the originating JournalEntryForm through the JournalEntryForm Id .

For updates, JournalEntryForms are requested to the JournalEntry Id that is to be updated using getJournalEntryFormsForUpdate() where the reference Id in the JournalEntryForm may be used to link the request. Similarly, the JournalEntryForm has metadata about the data that can be updated and it can perform validation before submitting the update. The JournalEntryForm can only be used once for a successful update and cannot be reused.

Once a batch of JournalEntryForms are submitted for update, an UpdateResponse is returned for each JournalEntryForm , although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateJournalEntries() , errors specific to an individual JournalEntryForm are indicated in the corresponding UpdateResponse . UpdateResponses may be linked to the originating JournalEntryForm through the JournalEntryForm Id .

The delete operations delete JournalEntries in bulk. To unmap a JournalEntry from the current Journal , the JournalEntryJournalAssignmentSession should be used. These delete operations attempt to remove the JournalEntry itself thus removing it from all known Journal catalogs. Bulk delete operations return the results in DeleteResponses .