Interface RecurringEventSmartCalendarSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface RecurringEventSmartCalendarSession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A RecurringEventQuery can be retrieved from this session and mapped to this Calendar to create a virtual collection of RecurringEvents . The entries may be sequenced using the RecurringEventSearchOrder from this session.

This Calendar has a default query that matches any recurring event and a default search order that specifies no sequencing. The queries may be examined using a RecurringEventQueryInspector . The query may be modified by converting the inspector back to a 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.

    • canManageSmartCalendars

      boolean canManageSmartCalendars()
      Tests if this user can manage smart calendars. 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 smart operations.
      Returns:
      false if smart calendar methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringEventQuery

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

    • getRecurringEventSearchOrder

      RecurringEventSearchOrder getRecurringEventSearchOrder()
      Gets a recurring event search order.
      Returns:
      the recurring event search order
      Compliance:
      mandatory - This method must be implemented.

    • applyRecurringEventQuery

      void applyRecurringEventQuery(RecurringEventQuery recurringEventQuery) throws OperationFailedException, PermissionDeniedException
      Applies a recurring event query to this calendar.
      Parameters:
      recurringEventQuery - the recurring event query
      Throws:
      NullArgumentException - recurringEventQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - recurringEventQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectRecurringEventQuery

      RecurringEventQueryInspector inspectRecurringEventQuery() throws OperationFailedException, PermissionDeniedException
      Gets a recurring event query inspector for this calendar.
      Returns:
      the recruring event query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyRecurringEventSequencing

      void applyRecurringEventSequencing(RecurringEventSearchOrder recurringEventSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a recurring event search order to this calendar.
      Parameters:
      recurringEventSearchOrder - the recurring event search order
      Throws:
      NullArgumentException - recurringEventSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - recurringEventSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringEventQueryFromInspector

      RecurringEventQuery getRecurringEventQueryFromInspector(RecurringEventQueryInspector recurringEventQueryInspector)
      Gets a recurring event query from an inspector.
      Parameters:
      recurringEventQueryInspector - a recurring event query inspector
      Returns:
      the recurring event query
      Throws:
      NullArgumentException - recruringEventQueryInspector is null
      UnsupportedException - recurringEventQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.