org.osid.recipe

Interface CookbookForm

All Superinterfaces:

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

All Known Subinterfaces:

CookbookBatchForm

public interface CookbookForm
extends OsidCatalogForm

This is the form for creating and updating Cookbooks. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CookbookAdminSession. 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
CookbookFormRecord	getCookbookFormRecord(Type cookbookRecordType) Gets the CookbookFormRecord corresponding to the given cookbook 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

getCookbookFormRecord

CookbookFormRecord getCookbookFormRecord(Type cookbookRecordType)
                                         throws OperationFailedException

Gets the CookbookFormRecord corresponding to the given cookbook record Type.

Parameters:

cookbookRecordType - the cookbook record type

Returns:

the cookbook form record

Throws:

NullArgumentException - cookbookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cookbookRecordType) is false

Compliance:

mandatory - This method must be implemented.