Interface CookbookForm
- All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable
- All Known Subinterfaces:
CookbookBatchForm
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.
Like all OsidForms, CookbookForm is stateful and must
not be accessed by multiple processing threads.
-
Method Summary
Modifier and TypeMethodDescriptiongetCookbookFormRecord(Type cookbookRecordType) Gets theCookbookFormRecordcorresponding to the given cookbook recordType.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeMethods inherited from interface Identifiable
getId, isCurrentMethods inherited from interface OsidExtensibleForm
getRequiredRecordTypesMethods inherited from interface OsidForm
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocaleMethods inherited from interface OsidObjectForm
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusTypeMethods inherited from interface OsidSourceableForm
clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider
-
Method Details
-
getCookbookFormRecord
Gets theCookbookFormRecordcorresponding to the given cookbook recordType.- Parameters:
cookbookRecordType- the cookbook record type- Returns:
- the cookbook form record
- Throws:
NullArgumentException-cookbookRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(cookbookRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-