Interface RecurringEventQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RecurringEventSearchSession
public interface RecurringEventQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated calendar view: searches include recurring events in calendars of which this calendar is an ancestor in the calendar hierarchy
  • isolated calendar view: searches are restricted to recurring events in this calendar
RecurringEvents may have a query record indicated by their respective record types. The query ecord is accessed via the RecurringEventQuery.

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

    • canSearchRecurringEvents

      boolean canSearchRecurringEvents()
      Tests if this user can perform RecurringEvents 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 recurring 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.

    • getRecurringEventQuery

      RecurringEventQuery getRecurringEventQuery()
      Gets a recurring event query.
      Returns:
      the recurring event query
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringEventsByQuery

      RecurringEventList getRecurringEventsByQuery(RecurringEventQuery recurringEventQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of RecurringEvents matching the given recurring event query.
      Parameters:
      recurringEventQuery - the recurring event query
      Returns:
      the returned RecurringEventList
      Throws:
      NullArgumentException - recurringEventQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - recurringEventQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.