Interface CourseRequirementSearchOrder

All Superinterfaces:
Extensible, OsidAggregateableSearchOrder, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable
public interface CourseRequirementSearchOrder extends OsidRuleSearchOrder, OsidAggregateableSearchOrder

An interface for specifying the ordering of CourseRequirement search results.

  • Method Details

    • orderByRequiresSubjectArea

      void orderByRequiresSubjectArea(SearchOrderStyle style)
      Specifies a preference for ordering results by the requires subject area flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderBySubjectArea

      void orderBySubjectArea(SearchOrderStyle style)
      Specifies a preference for ordering results by subject area.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectAreaSearchOrder

      boolean supportsSubjectAreaSearchOrder()
      Tests if a subject area search order is available.
      Returns:
      true if a subject area search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSubjectAreaSearchOrder

      SubjectSearchOrder getSubjectAreaSearchOrder()
      Gets the search order for a subject area.
      Returns:
      the search order
      Throws:
      UnimplementedException - supportsSubjectAreaSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubjectAreaSearchOrder()} is {@code true} .

    • orderByIncludeEquivalentUnits

      void orderByIncludeEquivalentUnits(SearchOrderStyle style)
      Specifies a preference for ordering results by the include equivalent units flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRequiresMinimumNumber

      void orderByRequiresMinimumNumber(SearchOrderStyle style)
      Specifies a preference for ordering results by the requires minimum number flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByMinimumNumber

      void orderByMinimumNumber(SearchOrderStyle style)
      Specifies a preference for ordering results by minimum number.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRequiresMinimumNonTransferNumber

      void orderByRequiresMinimumNonTransferNumber(SearchOrderStyle style)
      Specifies a preference for ordering results by the requires minimum non-transfer number flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByMinimumNonTransferNumber

      void orderByMinimumNonTransferNumber(SearchOrderStyle style)
      Specifies a preference for ordering results by minimum non-transfer number.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByHasTargetNumberForSet

      void orderByHasTargetNumberForSet(SearchOrderStyle style)
      Specifies a preference for ordering results by the target number for set flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByTargetSetNumber

      void orderByTargetSetNumber(SearchOrderStyle style)
      Specifies a preference for ordering results by target set number.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRequiresMinimumCredits

      void orderByRequiresMinimumCredits(SearchOrderStyle style)
      Specifies a preference for ordering results by the requires minimum credits flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByCreditScale

      void orderByCreditScale(SearchOrderStyle style)
      Specifies a preference for ordering results by credit scale.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCreditScaleSearchOrder

      boolean supportsCreditScaleSearchOrder()
      Tests if a credit scale search order is available.
      Returns:
      true if a credit scale search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCreditScaleSearchOrder

      GradeSystemSearchOrder getCreditScaleSearchOrder()
      Gets the search order for a credit scale.
      Returns:
      the search order
      Throws:
      UnimplementedException - supportsCreditScaleSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCreditScaleSearchOrder()} is {@code true} .

    • orderByMinimumCredits

      void orderByMinimumCredits(SearchOrderStyle style)
      Specifies a preference for ordering results by minimum credits.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRequiresMinimumNonTransferCredits

      void orderByRequiresMinimumNonTransferCredits(SearchOrderStyle style)
      Specifies a preference for ordering results by the requires minimum non-transfer credits flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByNonTransferCredits

      void orderByNonTransferCredits(SearchOrderStyle style)
      Specifies a preference for ordering results by non-transfer credits.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByHasTargetCreditsForSet

      void orderByHasTargetCreditsForSet(SearchOrderStyle style)
      Specifies a preference for ordering results by the target credits for set flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByTargetSetCredits

      void orderByTargetSetCredits(SearchOrderStyle style)
      Specifies a preference for ordering results by target set credits.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRequiresCompletion

      void orderByRequiresCompletion(SearchOrderStyle style)
      Specifies a preference for ordering results by the requires completion flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByHasMinimumGrade

      void orderByHasMinimumGrade(SearchOrderStyle style)
      Specifies a preference for ordering results by the has minimum grade flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByMinimumGrade

      void orderByMinimumGrade(SearchOrderStyle style)
      Specifies a preference for ordering results by minimum grade.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsMinimumGradeSearchOrder

      boolean supportsMinimumGradeSearchOrder()
      Tests if a minimum grade search order is available.
      Returns:
      true if a minimum grade search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getMinimumGradeSearchOrder

      GradeSearchOrder getMinimumGradeSearchOrder()
      Gets the search order for a minimum grade.
      Returns:
      the search order
      Throws:
      UnimplementedException - supportsMinimumGradeSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsMinimumGradeSearchOrder()} is {@code true} .

    • orderByHasMinimumScore

      void orderByHasMinimumScore(SearchOrderStyle style)
      Specifies a preference for ordering results by the has minimum score flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByMinimumScore

      void orderByMinimumScore(SearchOrderStyle style)
      Specifies a preference for ordering results by minimum score.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByHasMinimumEarnedCredits

      void orderByHasMinimumEarnedCredits(SearchOrderStyle style)
      Specifies a preference for ordering results by the has minimum earned credits flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByMinimumEarnedCredits

      void orderByMinimumEarnedCredits(SearchOrderStyle style)
      Specifies a preference for ordering results by minimum earned credits.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRequirementSearchOrderRecord

      CourseRequirementSearchOrderRecord getCourseRequirementSearchOrderRecord(Type courseRequirementSearchOrderRecordType) throws OperationFailedException
      Gets the course requirement query record corresponding to the given CourseRequirement record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      courseRequirementSearchOrderRecordType - a course requirement record type
      Returns:
      the course requirement search order record
      Throws:
      NullArgumentException - courseRequirementSearchOrderRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(courseRequirementSearchOrderRecordType) is false
      Compliance:
      mandatory - This method must be implemented.