org.osid.course

Interface CourseCatalogForm

All Superinterfaces:

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

All Known Subinterfaces:

CourseCatalogBatchForm

public interface CourseCatalogForm
extends OsidCatalogForm

This is the form for creating and updating course catalogs. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CourseCatalogAdminSession. 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
CourseCatalogFormRecord	getCourseCatalogFormRecord(Type courseCatalogRecordType) Gets the CourseCatalogFormRecord corresponding to the given course catalog 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

getCourseCatalogFormRecord

CourseCatalogFormRecord getCourseCatalogFormRecord(Type courseCatalogRecordType)
                                                   throws OperationFailedException

Gets the CourseCatalogFormRecord corresponding to the given course catalog record Type.

Parameters:

courseCatalogRecordType - a course catalog record type

Returns:

the course catalog form record

Throws:

NullArgumentException - courseCatalogRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseCatalogRecordType) is false

Compliance:

mandatory - This method must be implemented.