org.osid.course.program

Interface EnrollmentForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

EnrollmentBatchForm

public interface EnrollmentForm
extends OsidRelationshipForm

This is the form for creating and updating Enrollments. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the EnrollmentAdminSession. 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
EnrollmentFormRecord	getEnrollmentFormRecord(Type enrollmentRecordType) Gets the EnrollmentFormRecord corresponding to the given enrollment 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.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getEnrollmentFormRecord

EnrollmentFormRecord getEnrollmentFormRecord(Type enrollmentRecordType)
                                             throws OperationFailedException

Gets the EnrollmentFormRecord corresponding to the given enrollment record Type.

Parameters:

enrollmentRecordType - an enrollment record type

Returns:

the enrollment form record

Throws:

NullArgumentException - enrollmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(enrollmentRecordType) is false

Compliance:

mandatory - This method must be implemented.