Interface OffsetEventEnablerSmartCalendarSession

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

This session manages queries and sequencing to create "smart" dynamic calendars. An OffsetEventEnablerQuery can be retrieved from this session and mapped to this Calendar to create a virtual collection of offset event enablers. The offset event enablers may be sequenced using the OffsetEventEnablerSearchOrder from this session.

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

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

    • 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 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 operations to unauthorized users.
      Returns:
      false if smart calendar management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getOffsetEventEnablerQuery

      OffsetEventEnablerQuery getOffsetEventEnablerQuery()
      Gets an offset event enabler query.
      Returns:
      the offset event enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getOffsetEventEnablerSearchOrder

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

    • applyOffsetEventEnablerQuery

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

    • inspectOffsetEventEnablerQuery

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

    • applyOffsetEventEnablerSequencing

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

    • getOffsetEventEnablerQueryFromInspector

      OffsetEventEnablerQuery getOffsetEventEnablerQueryFromInspector(OffsetEventEnablerQueryInspector offsetEventEnablerQueryInspector)
      Gets an offset event enabler query from an inspector.
      Parameters:
      offsetEventEnablerQueryInspector - an offset event enabler query inspector
      Returns:
      the offset event enabler query
      Throws:
      NullArgumentException - offsetEventEnablerQueryInspector is null
      UnsupportedException - offsetEventEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.