org.osid.blogging

Interface BlogForm

All Superinterfaces:

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

All Known Subinterfaces:

BlogBatchForm

public interface BlogForm
extends OsidCatalogForm

This is the form for creating and updating blogs. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BlogAdminSession. 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
BlogFormRecord	getBlogFormRecord(Type blogRecordType) Gets the BlogFormRecord corresponding to the given blog 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

getBlogFormRecord

BlogFormRecord getBlogFormRecord(Type blogRecordType)
                                 throws OperationFailedException

Gets the BlogFormRecord corresponding to the given blog record Type.

Parameters:

blogRecordType - the blog record type

Returns:

the blog form record

Throws:

NullArgumentException - blogRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(blogRecordType) is false

Compliance:

mandatory - This method must be implemented.