Interface RegistrationTargetForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, Suppliable
All Known Subinterfaces:
RegistrationTargetBatchForm
public interface RegistrationTargetForm extends OsidObjectForm, OsidSubjugateableForm

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

  • Method Details

    • getActivitiesMetadata

      Metadata getActivitiesMetadata()
      Gets the metadata for activities.
      Returns:
      metadata for the activities
      Compliance:
      mandatory - This method must be implemented.

    • setActivities

      void setActivities(Id[] activityIds)
      Sets the activities.
      Parameters:
      activityIds - the new activities
      Throws:
      InvalidArgumentException - activityIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - acti ityIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearActivities

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

    • getCreditsMetadata

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

    • setCredits

      void setCredits(BigDecimal[] credits)
      Sets the credits.
      Parameters:
      credits - the new 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 credits.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getGradingOptionsMetadata

      Metadata getGradingOptionsMetadata()
      Gets the metadata for a set of grading options.
      Returns:
      metadata for the grading options
      Compliance:
      mandatory - This method must be implemented.

    • setGradingOptions

      void setGradingOptions(Id[] gradeSystemIds)
      Sets the grading options.
      Parameters:
      gradeSystemIds - the new grade systems
      Throws:
      InvalidArgumentException - gradeSystemIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - gradeSystemIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearGradingOptions

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

    • getRegistrationTargetFormRecord

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