org.osid.journaling

Interface JournalForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

JournalBatchForm

public interface JournalForm
extends OsidCatalogForm

This is the form for creating and updating Journals. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the JournalAdminSession. 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
JournalFormRecord	getJournalFormRecord(Type journalRecordType) Gets the JournalFormRecord corresponding to the given journal 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

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getJournalFormRecord

JournalFormRecord getJournalFormRecord(Type journalRecordType)
                                       throws OperationFailedException

Gets the JournalFormRecord corresponding to the given journal record Type.

Parameters:

journalRecordType - the journal record type

Returns:

the journal form record

Throws:

NullArgumentException - journalRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(journalRecordType) is false

Compliance:

mandatory - This method must be implemented.