Interface CyclicEventSmartCalendarSession

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

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

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

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

    • getCyclicEventQuery

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

    • getCyclicEventSearchOrder

      CyclicEventSearchOrder getCyclicEventSearchOrder()
      Gets a cyclic event search order.
      Returns:
      the cyclic event search order
      Compliance:
      mandatory - This method must be implemented.

    • applyEventQuery

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

    • inspectEventQuery

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

    • applyEventSequencing

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

    • getCyclicEventQueryFromInspector

      CyclicEventQuery getCyclicEventQueryFromInspector(CyclicEventQueryInspector cyclicEventQueryInspector)
      Gets a cyclic event query from an inspector.
      Parameters:
      cyclicEventQueryInspector - a cyclic event query inspector
      Returns:
      the cyclic event query
      Throws:
      NullArgumentException - cyclicEventQueryInspector is null
      UnsupportedException - cyclicEventQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.