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.
Modifier and Type | Method and Description |
---|---|
EnrollmentFormRecord |
getEnrollmentFormRecord(Type enrollmentRecordType)
Gets the
EnrollmentFormRecord corresponding to the
given enrollment record Type. |
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
EnrollmentFormRecord getEnrollmentFormRecord(Type enrollmentRecordType) throws OperationFailedException
EnrollmentFormRecord
corresponding to the
given enrollment record Type.
enrollmentRecordType
- an enrollment record typeNullArgumentException
- enrollmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(enrollmentRecordType)
is false
mandatory
- This method must be implemented.