Interface RegistrationSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByCourseRegistration

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

    • supportsCourseRegistrationSearchOrder

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

    • getCourseRegistrationSearchOrder

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

    • orderByRegistrationTarget

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

    • supportsRegistrationTargetSearchOrder

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

    • getRegistrationTargetSearchOrder

      RegistrationTargetSearchOrder getRegistrationTargetSearchOrder()
      Gets the registration target search order.
      Returns:
      the registration target search order
      Throws:
      UnimplementedException - supportsRegistrationTargetSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetSearchOrder()} is {@code true}.

    • orderByStudent

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

    • supportsStudentSearchOrder

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

    • getStudentSearchOrder

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

    • orderByGradingOption

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

    • supportsGradingOptionSearchOrder

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

    • getGradingOptionSearchOrder

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

    • getRegistrationSearchOrderRecord

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