Interface CyclicEventQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
CyclicEventSearchSession
public interface CyclicEventQuerySession extends OsidSession

This session provides methods for searching CyclicEvents. The search query is constructed using the CyclicEventQuery. The cyclic event record Type also specifies the record for the cyclic event query.

This session defines views that offer differing behaviors for searching.

  • federated calendar view: searches include cyclic 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

Cyclic events may have a query record indicated by their respective record types. The query record is accessed via the CyclicEventQuery.

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

    • canSearchCyclicEvents

      boolean canSearchCyclicEvents()
      Tests if this user can perform CyclicEvent 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 cyclic 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.

    • getCyclicEventQuery

      CyclicEventQuery getCyclicEventQuery()
      Gets a cyclic event query.
      Returns:
      the cyclic event query
      Compliance:
      mandatory - This method must be implemented.

    • getCyclicEventsByQuery

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