org.osid.forum

Interface ForumForm

All Superinterfaces:

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

All Known Subinterfaces:

ForumBatchForm

public interface ForumForm
extends OsidCatalogForm

This is the form for creating and updating Forums. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ForumAdminSession. 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
ForumFormRecord	getForumFormRecord(Type forumRecordType) Gets the ForumFormRecord corresponding to the given forum 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

getForumFormRecord

ForumFormRecord getForumFormRecord(Type forumRecordType)
                                   throws OperationFailedException

Gets the ForumFormRecord corresponding to the given forum record Type.

Parameters:

forumRecordType - the forum record type

Returns:

the forum form record

Throws:

NullArgumentException - forumRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(forumRecordType) is false

Compliance:

mandatory - This method must be implemented.