Interface ParticipantForm

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

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

  • Method Details

    • getTimePeriodMetadata

      Metadata getTimePeriodMetadata()
      Gets the metadata for a time period.
      Returns:
      metadata for the time period
      Compliance:
      mandatory - This method must be implemented.

    • setTimePeriod

      void setTimePeriod(Id timePeriodId)
      Sets the time period.
      Parameters:
      timePeriodId - the time period
      Throws:
      InvalidArgumentException - timePeriodId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - timePeriodId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTimePeriod

      void clearTimePeriod()
      Clears the time period.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getResultOptionsMetadata

      Metadata getResultOptionsMetadata()
      Gets the metadata for the grading options.
      Returns:
      metadata for the prerequisite information
      Compliance:
      mandatory - This method must be implemented.

    • setResultOptions

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

    • clearResultOptions

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

    • getParticipantFormRecord

      ParticipantFormRecord getParticipantFormRecord(Type participantRecordType) throws OperationFailedException
      Gets the ParticipantFormRecord interface corresponding to the given participant record Type.
      Parameters:
      participantRecordType - the participant record type
      Returns:
      the record
      Throws:
      NullArgumentException - participantRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(participantRecordType) is false
      Compliance:
      mandatory - This method must be implemented.