Interface CyclicEventSearch

All Superinterfaces:
Extensible, OsidCondition, OsidSearch, Suppliable
public interface CyclicEventSearch extends OsidSearch

EventSearch defines the interface for specifying event search options.

  • Method Details

    • searchAmongCyclicEvents

      void searchAmongCyclicEvents(IdList cyclicEventIds)
      Execute this search among the given list of events.
      Parameters:
      cyclicEventIds - list of events
      Throws:
      NullArgumentException - cyclicEventIds is null
      Compliance:
      mandatory - This method must be implemented.

    • orderCyclicEventResults

      void orderCyclicEventResults(CyclicEventSearchOrder cyclicEventSearchOrder)
      Specify an ordering to the search results.
      Parameters:
      cyclicEventSearchOrder - event search order
      Throws:
      NullArgumentException - cyclicEventSearchOrder is null
      UnsupportedException - cyclicEventSearchOrder is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getCyclicEventSearchRecord

      CyclicEventSearchRecord getCyclicEventSearchRecord(Type cyclicEventSearchRecordType) throws OperationFailedException
      Gets the cyclic event search record corresponding to the given event search record Type.This method is used to retrieve an object implementing the requested record.
      Parameters:
      cyclicEventSearchRecordType - a cyclic event search record type
      Returns:
      the cyclic event search record
      Throws:
      NullArgumentException - cyclicEventSearchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(cyclicEventSearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.