org.osid.journaling

Interface JournalEntryForm

All Superinterfaces:

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

All Known Subinterfaces:

JournalEntryBatchForm

public interface JournalEntryForm
extends OsidObjectForm, OsidSubjugateableForm

This is the form for creating and updating JournalEntry objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the JournalEntryAdminSession. 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
JournalEntryFormRecord	getJournalEntryFormRecord(Type journalEntryRecordType) Gets the JournalEntryFormRecord corresponding to the given journal entry record Type.

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

getJournalEntryFormRecord

JournalEntryFormRecord getJournalEntryFormRecord(Type journalEntryRecordType)
                                                 throws OperationFailedException

Gets the JournalEntryFormRecord corresponding to the given journal entry record Type.

Parameters:

journalEntryRecordType - the journal entry record type

Returns:

the journal entry form record

Throws:

NullArgumentException - journalEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(journalEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.