OSID Logo
OSID Specifications
journaling batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.batch.JournalEntryBatchAdminSession
Implementsosid.journaling.JournalEntryAdminSession
Description

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.

MethodgetJournalEntryFormsForCreate
Description

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

Parametersosid.journaling.batch.JournalEntryPeerListpeersa list of journal entry peers
osid.type.Type[]journalEntryRecordTypesarray of journal entry record types to be included in each create operation or an empty list if none
Returnosid.journaling.batch.JournalEntryBatchFormListthe journal entry forms
ErrorsNOT_FOUNDa branchId or sourceId is not found
NULL_ARGUMENT peers or journalEntryRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateJournalEntries
Description

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 .

Parametersosid.journaling.batch.JournalEntryBatchFormListjournalEntryFormsthe journal entry forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT journalEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntryFormsForUpdate
Description

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.

Parametersosid.id.IdListjournalEntryIdsthe Ids of the JournalEntry
Returnosid.journaling.batch.JournalEntryBatchFormListthe journal entry form
ErrorsNOT_FOUNDa journalEntryId is not found
NULL_ARGUMENT journalEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateJournalEntries
Description

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 .

Parametersosid.journaling.batch.JournalEntryBatchFormListjournalEntryFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT journalEntryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllJournalEntries
Description

Deletes all JournalEntries in this Journal .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteJournalEntries
Description

Deletes journal entries for the given Ids.

Parametersosid.id.IdListjournalEntryIdsthe Ids of the journal entries to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT journalEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteJournalEntriesForBranch
Description

Deletes journal entries for the given branch.

Parametersosid.id.IdbranchIdthe Id of a branch
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT branchId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteJournalEntriesForSource
Description

Deletes journal entries for the given source.

Parametersosid.id.IdsourceIdthe Id of a source
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT sourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteJournalEntriesByDate
Description

Deletes journal entries between the given date range inclusive.

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasJournalEntries
Description

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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.