Interface RegistrationForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable
All Known Subinterfaces:
RegistrationBatchForm
public interface RegistrationForm extends OsidRelationshipForm

This is the form for creating and updating Registrations. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RegistrationAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

  • Method Details

    • getCreditsMetadata

      Metadata getCreditsMetadata()
      Gets the metadata for registration credits.
      Returns:
      metadata for the registration credits
      Compliance:
      mandatory - This method must be implemented.

    • setCredits

      void setCredits(BigDecimal[] credits)
      Sets the registration credits.
      Parameters:
      credits - the new registration credits
      Throws:
      InvalidArgumentException - credits is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - credits is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCredits

      void clearCredits()
      Removes the registration credits.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getGradingOptionMetadata

      Metadata getGradingOptionMetadata()
      Gets the metadata for the grading option.
      Returns:
      metadata for the grading option
      Compliance:
      mandatory - This method must be implemented.

    • setGradingOption

      void setGradingOption(Id gradeSystemId)
      Sets the grading option.
      Parameters:
      gradeSystemId - the new grading option
      Throws:
      InvalidArgumentException - gradeSystemId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - gradeSystemId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearGradingOption

      void clearGradingOption()
      Removes the grading option.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationFormRecord

      RegistrationFormRecord getRegistrationFormRecord(Type registrationRecordType) throws OperationFailedException
      Gets the RegistrationFormRecord corresponding to the given registration record Type.
      Parameters:
      registrationRecordType - a registration record type
      Returns:
      the registration form record
      Throws:
      NullArgumentException - registrationRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(registrationRecordType) is false
      Compliance:
      mandatory - This method must be implemented.