Interface CommitmentEnablerSmartCalendarSession

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

This session manages queries and sequencing to create "smart" dynamic calendars. A CommitmentEnablerQuery can be retrieved from this session and mapped to this Calendar to create a virtual collection of commitment enablers. The commitment enablers may be sequenced using the CommitmentEnablerSearchOrder from this session.

This Calendar has a default query that matches any commitment enabler and a default search order that specifies no sequencing. The queries may be examined using a CommitmentEnablerQueryInspector . The query may be modified by converting the inspector back to a CommitmentEnablerQuery .

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

    • getCommitmentEnablerQuery

      CommitmentEnablerQuery getCommitmentEnablerQuery()
      Gets a commitment enabler query.
      Returns:
      the commitment enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getCommitmentEnablerSearchOrder

      CommitmentEnablerSearchOrder getCommitmentEnablerSearchOrder()
      Gets a commitment enabler search order.
      Returns:
      the commitment enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyCommitmentEnablerQuery

      void applyCommitmentEnablerQuery(CommitmentEnablerQuery commitmentEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Applies a commitment enabler query to this calendar.
      Parameters:
      commitmentEnablerQuery - the commitment enabler query
      Throws:
      NullArgumentException - commitmentEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - commitmentEnablerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectCommitmentEnablerQuery

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

    • applyCommitmentEnablerSequencing

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

    • getCommitmentEnablerQueryFromInspector

      CommitmentEnablerQuery getCommitmentEnablerQueryFromInspector(CommitmentEnablerQueryInspector commitmentEnablerQueryInspector)
      Gets a commitment enabler query from an inspector.
      Parameters:
      commitmentEnablerQueryInspector - a commitment enabler query inspector
      Returns:
      the commitment enabler query
      Throws:
      NullArgumentException - commitmentEnablerQueryInspector is null
      UnsupportedException - commitmentEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.