Interface CourseOfferingSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByCourse

      void orderByCourse(SearchOrderStyle style)
      Specifies a preference for ordering the result set by course.
      Parameters:
      style - a 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 term.
      Parameters:
      style - a 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} .

    • orderByTitle

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

    • orderByNumber

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

    • orderByPrerequisitesInfo

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

    • orderByRequiresRegistration

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

    • orderByMinimumSeats

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

    • orderByMaximumSeats

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

    • orderByURL

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

    • orderByScheduleInfo

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

    • orderByEvent

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

    • supportsEventSearchOrder

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

    • getEventSearchOrder

      EventSearchOrder getEventSearchOrder()
      Gets the event order.
      Returns:
      the event search order
      Throws:
      UnimplementedException - supportsEventSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEventSearchOrder()} is {@code true} .

    • getCourseOfferingSearchOrderRecord

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