Interface RecurringEventEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RecurringEventEnablerSearchSession
public interface RecurringEventEnablerQuerySession extends OsidSession

This session provides methods for searching among RecurringEventEnabler objects. The search query is constructed using the RecurringEventEnablerQuery.

This session defines views that offer differing behaviors for searching.

  • federated calendar view: searches include recurring event enablers in calendars of which this calendar is an ancestor in the calendar hierarchy
  • isolated calendar view: searches are restricted to recurring event enablers in this calendar

Recurring event enablers may have a query record indicated by their respective record types. The query record is accessed via the RecurringEventEnablerQuery.

  • 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
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchRecurringEventEnablers

      boolean canSearchRecurringEventEnablers()
      Tests if this user can perform RecurringEventEnabler lookups. 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 not offer lookup 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 event enablers in calendars which are children of this broker 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 lookups to this calendar only.
      Compliance:
      mandatory - This method is must be implemented.

    • getRecurringEventEnablerQuery

      RecurringEventEnablerQuery getRecurringEventEnablerQuery()
      Gets a recurring event enabler query.
      Returns:
      the recurring event enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringEventEnablersByQuery

      RecurringEventEnablerList getRecurringEventEnablersByQuery(RecurringEventEnablerQuery recurringEventEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of RecurringEventEnablers matching the given recurring event enabler query.
      Parameters:
      recurringEventEnablerQuery - the recurring event enabler query
      Returns:
      the returned RecurringEventEnablerList
      Throws:
      NullArgumentException - recurringEventEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - recurringEventEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.