Interface OffsetEventSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable
public interface OffsetEventSearchOrder extends OsidRuleSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByFixedStartTime

      void orderByFixedStartTime(SearchOrderStyle style)
      Specified a preference for ordering results by the fixed start time.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByStartReferenceEvent

      void orderByStartReferenceEvent(SearchOrderStyle style)
      Specified a preference for ordering results by the starting reference event.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsStartReferenceEventSearchOrder

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

    • getStartReferenceEventSearchOrder

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

    • orderByFixedStartOffset

      void orderByFixedStartOffset(SearchOrderStyle style)
      Specified a preference for ordering results by the fixed offset.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRelativeWeekdayStartOffset

      void orderByRelativeWeekdayStartOffset(SearchOrderStyle style)
      Specified a preference for ordering results by the relative weekday offset.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRelativeStartWeekday

      void orderByRelativeStartWeekday(SearchOrderStyle style)
      Specified a preference for ordering results by the relative weekday.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByFixedDuration

      void orderByFixedDuration(SearchOrderStyle style)
      Specified a preference for ordering results by the fixed duration.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByEndReferenceEvent

      void orderByEndReferenceEvent(SearchOrderStyle style)
      Specified a preference for ordering results by the ending reference event.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsEndReferenceEventSearchOrder

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

    • getEndReferenceEventSearchOrder

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

    • orderByFixedEndOffset

      void orderByFixedEndOffset(SearchOrderStyle style)
      Specified a preference for ordering results by the fixed offset.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRelativeWeekdayEndOffset

      void orderByRelativeWeekdayEndOffset(SearchOrderStyle style)
      Specified a preference for ordering results by the relative weekday offset.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRelativeEndWeekday

      void orderByRelativeEndWeekday(SearchOrderStyle style)
      Specified a preference for ordering results by the relative weekday.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByLocationDescription

      void orderByLocationDescription(SearchOrderStyle style)
      Specified a preference for ordering results by the location description.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByLocation

      void orderByLocation(SearchOrderStyle style)
      Specified a preference for ordering results by the location.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsLocationSearchOrder

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

    • getLocationSearchOrder

      LocationSearchOrder getLocationSearchOrder()
      Gets the search order for a location.
      Returns:
      the location search order
      Throws:
      UnimplementedException - supportsLocationSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsLocationSearchOrder()} is {@code true} .

    • getOffsetEventSearchOrderRecord

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