Interface EventSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidContainableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface EventSearchOrder extends OsidObjectSearchOrder, OsidTemporalSearchOrder, OsidContainableSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByDuration

      void orderByDuration(SearchOrderStyle style)
      Specified a preference for ordering results by the duration. For recurring events, the duration is the duration of a single event.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByRecurringEvent

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

    • supportsRecurringEventSearchOrder

      boolean supportsRecurringEventSearchOrder()
      Tests if a RecurringEventSearchOrder is available for recurring events.
      Returns:
      true if a recurring event search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringEventSearchOrder

      RecurringEventSearchOrder getRecurringEventSearchOrder()
      Gets the search order for a recurring event.
      Returns:
      the recurring event search order
      Throws:
      UnimplementedException - supportsRecurringEventSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRecurringEventSearchOrder()} is {@code true} .

    • orderBySupersedingEvent

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

    • supportsSupersedingEventSearchOrder

      boolean supportsSupersedingEventSearchOrder()
      Tests if a SupersedingEventSearchOrder is available for offset events.
      Returns:
      true if a superseding event search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventSearchOrder

      SupersedingEventSearchOrder getSupersedingEventSearchOrder()
      Gets the search order for a superseding event.
      Returns:
      the superseding event search order
      Throws:
      UnimplementedException - supportsSupersedingEventSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSupersedingEventSearchOrder()} is {@code true} .

    • orderByOffsetEvent

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

    • supportsOffsetEventSearchOrder

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

    • getOffsetEventSearchOrder

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

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

    • getEventSearchOrderRecord

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