org.osid.dictionary

Interface DictionaryForm

All Superinterfaces:

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

All Known Subinterfaces:

DictionaryBatchForm

public interface DictionaryForm
extends OsidCatalogForm

This is the form for creating and updating a Dictionary. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the DictionaryAdminSession. 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
DictionaryFormRecord	getDictionaryFormRecord(Type dictionaryRecordType) Gets the DictionaryFormRecord corresponding to the given dictionary 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

getDictionaryFormRecord

DictionaryFormRecord getDictionaryFormRecord(Type dictionaryRecordType)
                                             throws OperationFailedException

Gets the DictionaryFormRecord corresponding to the given dictionary record Type.

Parameters:

dictionaryRecordType - a dictionary record type

Returns:

the dictionary form record

Throws:

NullArgumentException - dictionaryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dictionaryRecordType) is false

Compliance:

mandatory - This method must be implemented.