Interface CourseEntrySearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface CourseEntrySearchOrder extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByStudent

      void orderByStudent(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the resource.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsStudentSearchOrder

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

    • getStudentSearchOrder

      ResourceSearchOrder getStudentSearchOrder()
      Gets the resource order.
      Returns:
      the resource search order
      Throws:
      UnimplementedException - supportsStudentSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStudentSearchOrder()} is {@code true} .

    • orderByCourse

      void orderByCourse(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the course.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseSearchOrder

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

    • getCourseSearchOrder

      CourseSearchOrder getCourseSearchOrder()
      Gets the course order.
      Returns:
      the course search order
      Throws:
      UnimplementedException - supportsCourseSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseSearchOrder()} is {@code true} .

    • orderByTerm

      void orderByTerm(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the term.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsTermSearchOrder

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

    • getTermSearchOrder

      TermSearchOrder getTermSearchOrder()
      Gets the term order.
      Returns:
      the term search order
      Throws:
      UnimplementedException - supportsTermSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsTermSearchOrder()} is {@code true} .

    • orderByIsRegistrationKnown

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

    • orderByCourseBeginDate

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

    • orderByCourseEndDate

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

    • orderByComplete

      void orderByComplete(SearchOrderStyle style)
      Specifies a preference for ordering the result set by completed courses.
      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 the result set by the grade system for credits.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCreditScaleSearchOrder

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

    • getCreditScaleSearchOrder

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

    • orderByCreditsEarned

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

    • orderByGrade

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

    • supportsGradeSearchOrder

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

    • getGradeSearchOrder

      GradeSearchOrder getGradeSearchOrder()
      Gets the grade system search order.
      Returns:
      the grade search order
      Throws:
      UnimplementedException - supportsGradeSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeSearchOrder()} is {@code true} .

    • orderByScoreScale

      void orderByScoreScale(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the grade system for scores.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsScoreScaleSearchOrder

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

    • getScoreScaleSearchOrder

      GradeSystemSearchOrder getScoreScaleSearchOrder()
      Gets the grade system order.
      Returns:
      the grade system search order
      Throws:
      UnimplementedException - supportsScoreScaleSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsScoreScaleSearchOrder()} is {@code true} .

    • orderByScore

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

    • getCourseEntrySearchOrderRecord

      CourseEntrySearchOrderRecord getCourseEntrySearchOrderRecord(Type courseEntryRecordType) throws OperationFailedException
      Gets the course entry search order record corresponding to the given course entry entry record Type . Multiple retrievals return the same underlying object.
      Parameters:
      courseEntryRecordType - a course entry record type
      Returns:
      the course entry search order record
      Throws:
      NullArgumentException - courseEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(courseEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.