org.osid.journaling.batch

Interface JournalEntryBatchForm

All Superinterfaces:

Extensible, Identifiable, JournalEntryForm, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, Suppliable

public interface JournalEntryBatchForm
extends JournalEntryForm

This is the form for creating and updating journal entries in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the JournalEntryBatchAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
Id	getBranchId() Gets the Branch Id of the journal entry if this is a create transaction.
Id	getJournalEntryId() Gets the Id of the journal entry to be updated if this is an update transaction.
Id	getSourceId() Gets the source Id of the journal entry if this is a create transaction.

Methods inherited from interface org.osid.journaling.JournalEntryForm

getJournalEntryFormRecord

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getBranchId

Id getBranchId()

Gets the Branch Id of the journal entry if this is a create transaction.

Returns:

the branch Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getSourceId

Id getSourceId()

Gets the source Id of the journal entry if this is a create transaction.

Returns:

the source Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getJournalEntryId

Id getJournalEntryId()

Gets the Id of the journal entry to be updated if this is an update transaction.

Returns:

the journal entry Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.