Interface ActivityRegistrationSearchOrder

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

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} .

    • orderByActivity

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

    • supportsActivitySearchOrder

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

    • getActivitySearchOrder

      ActivitySearchOrder getActivitySearchOrder()
      Gets the activity search order.
      Returns:
      the activity search order
      Throws:
      UnimplementedException - supportsActivitySearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivitySearchOrder()} 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} .

    • getActivityRegistrationSearchOrderRecord

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