Interface MessageSmartMailboxSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A MessageQuery can be retrieved from this session and mapped to this Map to create a virtual collection of Messages . The messages may be sequenced using the MessageSearchOrder from this session.

This Mailbox has a default query that matches any message and a default search order that specifies no sequencing. The queries may be examined using a MessageQueryInspector . The query may be modified by converting the inspector back to a MessageQuery .

  • Method Details

    • getMailboxId

      Id getMailboxId()
      Gets the Mailbox Id associated with this session.
      Returns:
      the Mailbox Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getMailbox

      Mailbox getMailbox() throws OperationFailedException, PermissionDeniedException
      Gets the Mailbox associated with this session.
      Returns:
      the Mailbox associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartMailboxes

      boolean canManageSmartMailboxes()
      Tests if this user can manage smart mailboxes. 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 mailbox management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getMessageQuery

      MessageQuery getMessageQuery()
      Gets a message query.
      Returns:
      the message query
      Compliance:
      mandatory - This method must be implemented.

    • getMessageSearchOrder

      MessageSearchOrder getMessageSearchOrder()
      Gets a message search order.
      Returns:
      the message search order
      Compliance:
      mandatory - This method must be implemented.

    • applyMessageQuery

      void applyMessageQuery(MessageQuery messageQuery) throws OperationFailedException, PermissionDeniedException
      Applies a message query to this mailbox.
      Parameters:
      messageQuery - the message query
      Throws:
      NullArgumentException - messageQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - messageQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspecMessageQuery

      MessageQueryInspector inspecMessageQuery() throws OperationFailedException, PermissionDeniedException
      Gets a message query inspector for this mailbox.
      Returns:
      the message query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyMessageSequencing

      void applyMessageSequencing(MessageSearchOrder messageSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a message search order to this mailbox.
      Parameters:
      messageSearchOrder - the message search order
      Throws:
      NullArgumentException - messageSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - messageSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getMessageQueryFromInspector

      MessageQuery getMessageQueryFromInspector(MessageQueryInspector messageQueryInspector)
      Gets a message query from an inspector.
      Parameters:
      messageQueryInspector - a message query inspector
      Returns:
      the message query
      Throws:
      NullArgumentException - messageQueryInspector is null
      UnsupportedException - messageQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.