Interface AssessmentPartForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidContainableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, Suppliable
public interface AssessmentPartForm extends OsidObjectForm, OsidContainableForm, OsidOperableForm

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

  • Method Details

    • getWeightMetadata

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

    • setWeight

      void setWeight(long weight)
      Sets the weight on a scale from 0-100.
      Parameters:
      weight - the new weight
      Throws:
      InvalidArgumentException - weight is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearWeight

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

    • getAllocatedTimeMetadata

      Metadata getAllocatedTimeMetadata()
      Gets the metadata for the allocated time.
      Returns:
      metadata for the allocated time
      Compliance:
      mandatory - This method must be implemented.

    • setAllocatedTime

      void setAllocatedTime(Duration time)
      Sets the allocated time.
      Parameters:
      time - the allocated time
      Throws:
      InvalidArgumentException - time is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearAllocatedTime

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

    • getAssessmentPartFormRecord

      AssessmentPartFormRecord getAssessmentPartFormRecord(Type assessmentPartRecordType) throws OperationFailedException
      Gets the AssessmentPartFormRecord corresponding to the given assessment record Type .
      Parameters:
      assessmentPartRecordType - the assessment part record type
      Returns:
      the assessment part record
      Throws:
      NullArgumentException - assessmentPartRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(assessmentPartRecordType) is false
      Compliance:
      mandatory - This method must be implemented.