Interface CourseRegistrationSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByCourseOffering

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

    • supportsCourseOfferingSearchOrder

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

    • getCourseOfferingSearchOrder

      CourseOfferingSearchOrder getCourseOfferingSearchOrder()
      Gets the course offering search order.
      Returns:
      the course offering search order
      Throws:
      UnimplementedException - supportsCourseOfferingSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseOfferingSearchOrder()} 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} .

    • getCourseRegistrationSearchOrderRecord

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