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.

Like all OsidForms, EnrollmentForm is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getParentEnrollmentMetadata

      Metadata getParentEnrollmentMetadata()
      Gets the metadata for the parent enrollment.
      Returns:
      metadata for the parent enrollment
      Compliance:
      mandatory - This method must be implemented.

    • setParentEnrollment

      void setParentEnrollment(Id enrollmentId)
      Sets the parent enrollment.
      Parameters:
      enrollmentId - the new parent enrollment
      Throws:
      InvalidArgumentException - enrollmentId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - enrollmentId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearParentEnrollment

      void clearParentEnrollment()
      Removes the parent enrollment.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • 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.