org.osid.commenting

Interface BookForm

All Superinterfaces:

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

All Known Subinterfaces:

BookBatchForm

public interface BookForm
extends OsidCatalogForm

This is the form for creating and updating Books. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BookAdminSession. 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
BookFormRecord	getBookFormRecord(Type bookRecordType) Gets the BookFormRecord corresponding to the given book 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

getBookFormRecord

BookFormRecord getBookFormRecord(Type bookRecordType)
                                 throws OperationFailedException

Gets the BookFormRecord corresponding to the given book record Type.

Parameters:

bookRecordType - the book record type

Returns:

the book form record

Throws:

NullArgumentException - bookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bookRecordType) is false

Compliance:

mandatory - This method must be implemented.