org.osid.journaling.batch

Interface JournalBatchAdminSession

All Superinterfaces:

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

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasJournals(AliasRequestList aliasRequests) Adds an Id to a Journal for the purpose of creating compatibility.
CreateResponseList	createJournals(JournalBatchFormList journalForms) Creates a new set of Journals.
DeleteResponseList	deleteAllJournals() Deletes all Journals.
DeleteResponseList	deleteJournals(IdList journalIds) Deletes journals for the given Ids.
JournalBatchFormList	getJournalFormsForCreate(long number, Type[] journalRecordTypes) Gets the journal forms for creating a bunch of new journals.
JournalBatchFormList	getJournalFormsForUpdate(IdList journalIds) Gets the journal forms for updating an existing set of journals.
UpdateResponseList	updateJournals(JournalBatchFormList journalForms) Updates existing journals.

Methods inherited from interface org.osid.journaling.JournalAdminSession

aliasJournal, canCreateJournals, canCreateJournalWithRecordTypes, canDeleteJournals, canManageJournalAliases, canUpdateJournals, createJournal, deleteJournal, getJournalFormForCreate, getJournalFormForUpdate, updateJournal

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

getJournalFormsForCreate

JournalBatchFormList getJournalFormsForCreate(long number,
                                            Type[] journalRecordTypes)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

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

Returns:

the journal forms

Throws:

NullArgumentException - journalRecordTypes 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.

createJournals

CreateResponseList createJournals(JournalBatchFormList journalForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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 .

Parameters:

journalForms - the journal forms

Returns:

the create responses

Throws:

NullArgumentException - journalForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJournalFormsForUpdate

JournalBatchFormList getJournalFormsForUpdate(IdList journalIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

journalIds - the Ids of the Journal

Returns:

the journal form

Throws:

NotFoundException - a journalId is not found

NullArgumentException - journalIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateJournals

UpdateResponseList updateJournals(JournalBatchFormList journalForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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 .

Parameters:

journalForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - journalForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllJournals

DeleteResponseList deleteAllJournals()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Journals.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteJournals

DeleteResponseList deleteJournals(IdList journalIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes journals for the given Ids.

Parameters:

journalIds - the Ids of the journals to delete

Returns:

the delete responses

Throws:

NullArgumentException - journalIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasJournals

AliasResponseList aliasJournals(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

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.

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.