OSID Logo
OSID Specifications
journaling batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.batch.JournalBatchAdminSession
Implementsosid.journaling.JournalAdminSession
Description

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.

MethodgetJournalFormsForCreate
Description

Gets the journal forms for creating a bunch of new journals.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]journalRecordTypesarray of journal record types to be included in each create operation or an empty list if none
Returnosid.journaling.batch.JournalBatchFormListthe journal forms
ErrorsNULL_ARGUMENT journalRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateJournals
Description

Creates a new set of Journals. 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.JournalBatchFormListjournalFormsthe journal forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT journalForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalFormsForUpdate
Description

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

Parametersosid.id.IdListjournalIdsthe Ids of the Journal
Returnosid.journaling.batch.JournalBatchFormListthe journal form
ErrorsNOT_FOUNDa journalId is not found
NULL_ARGUMENT journalIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateJournals
Description

Updates existing journals. 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.JournalBatchFormListjournalFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT journalForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllJournals
Description

Deletes all Journals.

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

Deletes journals for the given Ids.

Parametersosid.id.IdListjournalIdsthe Ids of the journals to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT journalIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasJournals
Description

Adds an 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.

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.