Interface ActivitySearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByActivityUnit

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

    • supportsActivityUnitSearchOrder

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

    • getActivityUnitSearchOrder

      CourseSearchOrder getActivityUnitSearchOrder()
      Gets the activity unit search order.
      Returns:
      the activity unit search order
      Throws:
      UnimplementedException - supportsActivityUnitSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsActivityUnitSearchOrder()} is {@code true} .

    • 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 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 supportsActivityUnitSearchOrder()} 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 search order is available.
      Returns:
      true if a term search 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} .

    • orderByImplicit

      void orderByImplicit(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the implicit status.
      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.

    • orderByTotalTargetEffort

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

    • orderByTotalTargetContactTime

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

    • orderByTotalTargetIndividualEffort

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

    • orderByRecurringWeekly

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

    • orderByWeeklyEffort

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

    • orderByWeeklyContactTime

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

    • orderByWeeklyIndividualEffort

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

    • getActivitySearchOrderRecord

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