Interface OffsetEventSmartCalendarSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An OffsetEventQuery can be retrieved from this session and mapped to this Calendar to create a virtual collection of OffsetEvents . The entries may be sequenced using the OffsetEventSearchOrder from this session.

This Calendar has a default query that matches any offset event and a default search order that specifies no sequencing. The queries may be examined using an OffsetEventQueryInspector . The query may be modified by converting the inspector back to an OffsetEventQuery .

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

    • getOffsetEventQuery

      OffsetEventQuery getOffsetEventQuery()
      Gets an offset event query.
      Returns:
      the offset event query
      Compliance:
      mandatory - This method must be implemented.

    • getOffsetEventSearchOrder

      OffsetEventSearchOrder getOffsetEventSearchOrder()
      Gets an offset event search order.
      Returns:
      the offset event search order
      Compliance:
      mandatory - This method must be implemented.

    • applyOffsetEventQuery

      void applyOffsetEventQuery(OffsetEventQuery offsetEventQuery) throws OperationFailedException, PermissionDeniedException
      Applies an offset event query to this calendar.
      Parameters:
      offsetEventQuery - the offset event query
      Throws:
      NullArgumentException - offsetEventQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - offsetEventQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectOffsetEventQuery

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

    • applyOffsetEventSequencing

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

    • getOffsetEventQueryFromInspector

      OffsetEventQuery getOffsetEventQueryFromInspector(OffsetEventQueryInspector offsetEventQueryInspector)
      Gets an offset event query from an inspector.
      Parameters:
      offsetEventQueryInspector - an offset event query inspector
      Returns:
      the offset event query
      Throws:
      NullArgumentException - offsetEventQueryInspector is null
      UnsupportedException - offsetEventQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.