org.osid.journaling.batch

Interface JournalEntryBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, JournalEntryAdminSession, 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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasJournalEntries(AliasRequestList aliasRequests) Adds an Id to a JournalEntry for the purpose of creating compatibility.
CreateResponseList	createJournalEntries(JournalEntryBatchFormList journalEntryForms) Creates a new set of Journal Entries.
DeleteResponseList	deleteAllJournalEntries() Deletes all JournalEntries in this Journal .
DeleteResponseList	deleteJournalEntries(IdList journalEntryIds) Deletes journal entries for the given Ids.
DeleteResponseList	deleteJournalEntriesByDate(DateTime from, DateTime to) Deletes journal entries between the given date range inclusive.
DeleteResponseList	deleteJournalEntriesForBranch(Id branchId) Deletes journal entries for the given branch.
DeleteResponseList	deleteJournalEntriesForSource(Id sourceId) Deletes journal entries for the given source.
JournalEntryBatchFormList	getJournalEntryFormsForCreate(JournalEntryPeerList peers, Type[] journalEntryRecordTypes) Gets the journal entry forms for creating a bunch of new journal entries.
JournalEntryBatchFormList	getJournalEntryFormsForUpdate(IdList journalEntryIds) Gets the journal entry forms for updating an existing set of journal entries.
UpdateResponseList	updateJournalEntries(JournalEntryBatchFormList journalEntryForms) Updates existing journal entries.

Methods inherited from interface org.osid.journaling.JournalEntryAdminSession

aliasJournalEntry, canCreateJournalEntries, canCreateJournalEntryWithRecordTypes, canDeleteJournalEntries, canManageJournalEntryAliases, canUpdateJournalEntries, createJournalEntry, deleteJournalEntry, getJournal, getJournalEntryFormForCreate, getJournalEntryFormForUpdate, getJournalId, updateJournalEntry

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getJournalEntryFormsForCreate

JournalEntryBatchFormList getJournalEntryFormsForCreate(JournalEntryPeerList peers,
                                                      Type[] journalEntryRecordTypes)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the journal entry forms for creating a bunch of new journal entries. A JournalEntryForm is returned for each supplied branch and source.

Parameters:

peers - a list of journal entry peers

journalEntryRecordTypes - array of journal entry record types to be included in each create operation or an empty list if none

Returns:

the journal entry forms

Throws:

NotFoundException - a branchId or sourceId is not found

NullArgumentException - peers or journalEntryRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createJournalEntries

CreateResponseList createJournalEntries(JournalEntryBatchFormList journalEntryForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Creates a new set of Journal Entries. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

journalEntryForms - the journal entry forms

Returns:

the create responses

Throws:

NullArgumentException - journalEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJournalEntryFormsForUpdate

JournalEntryBatchFormList getJournalEntryFormsForUpdate(IdList journalEntryIds)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the journal entry forms for updating an existing set of journal entries. A new journal entry form should be requested for each update transaction.

Parameters:

journalEntryIds - the Ids of the JournalEntry

Returns:

the journal entry form

Throws:

NotFoundException - a journalEntryId is not found

NullArgumentException - journalEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateJournalEntries

UpdateResponseList updateJournalEntries(JournalEntryBatchFormList journalEntryForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Updates existing journal entries. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

journalEntryForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - journalEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllJournalEntries

DeleteResponseList deleteAllJournalEntries()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes all JournalEntries in this Journal .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteJournalEntries

DeleteResponseList deleteJournalEntries(IdList journalEntryIds)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes journal entries for the given Ids.

Parameters:

journalEntryIds - the Ids of the journal entries to delete

Returns:

the delete responses

Throws:

NullArgumentException - journalEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteJournalEntriesForBranch

DeleteResponseList deleteJournalEntriesForBranch(Id branchId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Deletes journal entries for the given branch.

Parameters:

branchId - the Id of a branch

Returns:

the delete responses

Throws:

NullArgumentException - branchId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteJournalEntriesForSource

DeleteResponseList deleteJournalEntriesForSource(Id sourceId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Deletes journal entries for the given source.

Parameters:

sourceId - the Id of a source

Returns:

the delete responses

Throws:

NullArgumentException - sourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteJournalEntriesByDate

DeleteResponseList deleteJournalEntriesByDate(DateTime from,
                                            DateTime to)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Deletes journal entries between the given date range inclusive.

Parameters:

from - start of date range

to - end of date range

Returns:

the delete responses

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasJournalEntries

AliasResponseList aliasJournalEntries(AliasRequestList aliasRequests)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Adds an Id to a JournalEntry for the purpose of creating compatibility. The primary Id of the JournalEntry is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another journal entry, it is reassigned to the given entry Id.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.