org.osid.course.syllabus

Interface ModuleForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidGovernatorForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSourceableForm, OsidSubjugateableForm, Suppliable

All Known Subinterfaces:

ModuleBatchForm

public interface ModuleForm
extends OsidGovernatorForm, OsidSubjugateableForm

This is the form for creating and updating Module objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ModuleAdminSession. 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
ModuleFormRecord	getModuleFormRecord(Type moduleRecordType) Gets the ModuleFormRecord corresponding to the given module 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.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getModuleFormRecord

ModuleFormRecord getModuleFormRecord(Type moduleRecordType)
                                     throws OperationFailedException

Gets the ModuleFormRecord corresponding to the given module record Type.

Parameters:

moduleRecordType - the module record type

Returns:

the module form record

Throws:

NullArgumentException - moduleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(moduleRecordType) is false

Compliance:

mandatory - This method must be implemented.