Interface PlanSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderBySyllabus

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

    • supportsSyllabusSearchOrder

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

    • getSyllabusSearchOrder

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

    • orderByCourseOffering

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

    • supportsCourseOfferingSearchOrder

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

    • getCourseOfferingSearchOrder

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

    • getPlanSearchOrderRecord

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