Interface CourseRequirementForm

All Superinterfaces:
Extensible, Identifiable, OsidAggregateableForm, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable
public interface CourseRequirementForm extends OsidRuleForm, OsidAggregateableForm

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

  • Method Details

    • getCoursesMetadata

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

    • setCourses

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

    • clearCourses

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

    • getRequiresSubjectAreaMetadata

      Metadata getRequiresSubjectAreaMetadata()
      Gets the metadata for the requires subject area flag.
      Returns:
      metadata for the requires subject area flag
      Compliance:
      mandatory - This method must be implemented.

    • setRequiresSubjectArea

      void setRequiresSubjectArea(boolean requiresSubjectArea)
      Sets the requires subject area flag.
      Parameters:
      requiresSubjectArea - the new requires subject area flag
      Throws:
      InvalidArgumentException - requiresSubjectArea is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiresSubjectArea

      void clearRequiresSubjectArea()
      Clears the requires subject area flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getSubjectAreaMetadata

      Metadata getSubjectAreaMetadata()
      Gets the metadata for the subject area.
      Returns:
      metadata for the subject area
      Compliance:
      mandatory - This method must be implemented.

    • setSubjectArea

      void setSubjectArea(Id subjectAreaId)
      Sets the subject area.
      Parameters:
      subjectAreaId - the new subject area
      Throws:
      InvalidArgumentException - subjectAreaId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - subjectAreaId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearSubjectArea

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

    • getIncludeEquivalentUnitsMetadata

      Metadata getIncludeEquivalentUnitsMetadata()
      Gets the metadata for the include equivalent units flag.
      Returns:
      metadata for the include equivalent units flag
      Compliance:
      mandatory - This method must be implemented.

    • setIncludeEquivalentUnits

      void setIncludeEquivalentUnits(boolean includeEquivalentUnits)
      Sets the include equivalent units flag.
      Parameters:
      includeEquivalentUnits - the new include equivalent units flag
      Throws:
      InvalidArgumentException - includeEquivalentUnits is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearIncludeEquivalentUnits

      void clearIncludeEquivalentUnits()
      Clears the include equivalent units flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getMinimumNumberMetadata

      Metadata getMinimumNumberMetadata()
      Gets the metadata for the minimum number of courses.
      Returns:
      metadata for the minimum number
      Compliance:
      mandatory - This method must be implemented.

    • setMinimumNumber

      void setMinimumNumber(long number)
      Sets the minimum number of courses to complete from the set.
      Parameters:
      number - the new minimum number
      Throws:
      InvalidArgumentException - number is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumNumber

      void clearMinimumNumber()
      Clears the minimum number of courses.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getMinimumNonTransferNumberMetadata

      Metadata getMinimumNonTransferNumberMetadata()
      Gets the metadata for the minimum number of non-transfer courses.
      Returns:
      metadata for the minimum non-transfer number
      Compliance:
      mandatory - This method must be implemented.

    • setMinimumNonTransferNumber

      void setMinimumNonTransferNumber(long number)
      Sets the minimum number of non-transfer courses to complete from the set.
      Parameters:
      number - the new minimum non-transfer number
      Throws:
      InvalidArgumentException - number is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumNonTransferNumber

      void clearMinimumNonTransferNumber()
      Clears the minimum non-transfer number of courses.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getTargetSetNumberMetadata

      Metadata getTargetSetNumberMetadata()
      Gets the metadata for the target number of courses in the set.
      Returns:
      metadata for the target set number
      Compliance:
      mandatory - This method must be implemented.

    • setTargetSetNumber

      void setTargetSetNumber(long number)
      Sets the target number of courses in the set.
      Parameters:
      number - the new target set number
      Throws:
      InvalidArgumentException - number is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearTargetSetNumber

      void clearTargetSetNumber()
      Clears the target set number.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getMinimumCreditsMetadata

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

    • setMinimumCredits

      void setMinimumCredits(BigDecimal credits)
      Sets the minimum credits.
      Parameters:
      credits - the new minimum credits
      Throws:
      InvalidArgumentException - credits is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumCredits

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

    • getCreditScaleMetadata

      Metadata getCreditScaleMetadata()
      Gets the metadata for the credit scale.
      Returns:
      metadata for the credit scale
      Compliance:
      mandatory - This method must be implemented.

    • setCreditScale

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

    • clearCreditScale

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

    • getNonTransferCreditsMetadata

      Metadata getNonTransferCreditsMetadata()
      Gets the metadata for the minimum non-transfer credits.
      Returns:
      metadata for the non-transfer credits
      Compliance:
      mandatory - This method must be implemented.

    • setNonTransferCredits

      void setNonTransferCredits(BigDecimal credits)
      Sets the minimum non-transfer credits.
      Parameters:
      credits - the new minimum non-transfer credits
      Throws:
      InvalidArgumentException - credits is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearNonTransferCredits

      void clearNonTransferCredits()
      Clears the non-transfer credits.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getTargetSetCreditsMetadata

      Metadata getTargetSetCreditsMetadata()
      Gets the metadata for the target credits in the set.
      Returns:
      metadata for the target set credits
      Compliance:
      mandatory - This method must be implemented.

    • setTargetSetCredits

      void setTargetSetCredits(BigDecimal credits)
      Sets the target credits in the set.
      Parameters:
      credits - the new target set credits
      Throws:
      InvalidArgumentException - credits is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearTargetSetCredits

      void clearTargetSetCredits()
      Clears the target set credits.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getRequiresCompletionMetadata

      Metadata getRequiresCompletionMetadata()
      Gets the metadata for the requires completion flag.
      Returns:
      metadata for the requires completion flag
      Compliance:
      mandatory - This method must be implemented.

    • setRequiresCompletion

      void setRequiresCompletion(boolean completion)
      Sets the requires completion flag.
      Parameters:
      completion - the new requires completion flag
      Throws:
      InvalidArgumentException - completion is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiresCompletion

      void clearRequiresCompletion()
      Clears the requires completion flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getTimeframeMetadata

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

    • setTimeframe

      void setTimeframe(Duration duration)
      Sets the timeframe.
      Parameters:
      duration - the new duration
      Throws:
      InvalidArgumentException - duration is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - duration is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTimeframe

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

    • getMinimumGradeMetadata

      Metadata getMinimumGradeMetadata()
      Gets the metadata for the minimum grade.
      Returns:
      metadata for the minimum grade
      Compliance:
      mandatory - This method must be implemented.

    • setMinimumGrade

      void setMinimumGrade(Id gradeId)
      Sets the minimum grade.
      Parameters:
      gradeId - the new grade
      Throws:
      InvalidArgumentException - gradeId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - gradeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumGrade

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

    • getMinimumScoreSystemMetadata

      Metadata getMinimumScoreSystemMetadata()
      Gets the metadata for the minimum score system.
      Returns:
      metadata for the minimum score system
      Compliance:
      mandatory - This method must be implemented.

    • setMinimumScoreSystem

      void setMinimumScoreSystem(Id gradeSystemId)
      Sets the minimum score system.
      Parameters:
      gradeSystemId - the new grade system
      Throws:
      InvalidArgumentException - gradeSystemId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - gradeSystemId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumScoreSystem

      void clearMinimumScoreSystem()
      Clears the minimum score system.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getMinimumScoreMetadata

      Metadata getMinimumScoreMetadata()
      Gets the metadata for the minimum score.
      Returns:
      metadata for the minimum score
      Compliance:
      mandatory - This method must be implemented.

    • setMinimumScore

      void setMinimumScore(BigDecimal score)
      Sets the minimum score.
      Parameters:
      score - the new minimum score
      Throws:
      InvalidArgumentException - score is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumScore

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

    • getMinimumEarnedCreditsMetadata

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

    • setMinimumEarnedCredits

      void setMinimumEarnedCredits(BigDecimal credits)
      Sets the minimum earned credits.
      Parameters:
      credits - the new minimum earned credits
      Throws:
      InvalidArgumentException - credits is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumEarnedCredits

      void clearMinimumEarnedCredits()
      Clears the minimum earned credits.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRequirementFormRecord

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