Interface EventQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
EventSearchSession
public interface EventQuerySession extends OsidSession

This session provides methods for searching Event objects. The search query is constructed using the EventQuery . The event record Type also specifies the record for the event query.

This session defines views that offer differing behaviors for searching.

  • federated calendar view: searches include events in calendars of which this calendar is an ancestor in the calendar hierarchy
  • isolated calendar view: searches are restricted to events in this calendar
  • denormalized event view: recurring events are expanded into a series of non-recurring events
  • normalized event view: a series of recurring events is represented by a single Event
  • sequestered event viiew: All event methods suppress sequestered events.
  • unsequestered event view: All event methods return all events.

Events may have a query record indicated by their respective record types. The query record is accessed via the EventQuery .

  • Method Details

    • getCalendarId

      Id getCalendarId()
      Gets the Calendar Id associated with this session.
      Returns:
      the Calendar Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCalendar

      Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
      Gets the Calendar associated with this session.
      Returns:
      the Calendar associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchEvents

      boolean canSearchEvents()
      Tests if this user can perform Events searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedCalendarView

      void useFederatedCalendarView()
      Federates the view for methods in this session. A federated view will include events in calendars which are children of this calendar in the calendar hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCalendarView

      void useIsolatedCalendarView()
      Isolates the view for methods in this session. An isolated view restricts searches to this calendar only.
      Compliance:
      mandatory - This method is must be implemented.

    • useNormalizedEventView

      void useNormalizedEventView()
      A normalized view uses a single Event to represent a set of recurring events.
      Compliance:
      mandatory - This method is must be implemented.

    • useDenormalizedEventView

      void useDenormalizedEventView()
      A denormalized view expands recurring events into a series of Events .
      Compliance:
      mandatory - This method is must be implemented.

    • useSequesteredEventView

      void useSequesteredEventView()
      The returns from the search methods omit sequestered events.
      Compliance:
      mandatory - This method is must be implemented.

    • useUnsequesteredEventView

      void useUnsequesteredEventView()
      All replies are returned including sequestered events.
      Compliance:
      mandatory - This method is must be implemented.

    • getEventQuery

      EventQuery getEventQuery()
      Gets an event query.
      Returns:
      the event query
      Compliance:
      mandatory - This method must be implemented.

    • getEventsByQuery

      EventList getEventsByQuery(EventQuery eventQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Events matching the given event query.
      Parameters:
      eventQuery - the event query
      Returns:
      the returned EventList
      Throws:
      NullArgumentException - eventQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - eventQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.