Package com.qfs.snl.messages

Interface IMessageService.IMessageBox

All Known Implementing Classes:
MessageBox
Enclosing interface:
IMessageService
public static interface IMessageService.IMessageBox
IMessageBox interface represents ActiveMonitor Messages.
Author:
ActiveViam

  • Method Details

    • getMessages

      Collection<IMessage> getMessages()
      Gets all messages received by a given recipient.
      Returns:
      the messages for in the mailbox

    • delete

      void delete(long messageId) throws ServiceException
      Deletes a message.
      Parameters:
      messageId - id of the message to delete
      Throws:
      ServiceException - if an error occurs.

    • markAsRead

      void markAsRead(long messageId) throws ServiceException
      Marks the message as read.
      Parameters:
      messageId - id of the message to flag
      Throws:
      ServiceException - if an error occurs.

    • answer

      void answer(long messageId, Object answer) throws ServiceException
      Answers a message.
      Parameters:
      messageId - the id of the message to answer
      answer - the content of the answer.
      Throws:
      ServiceException - if an error occurs.

    • subscribe

      void subscribe(IMessageSubscriber client)
      Subscribes to all messages of a given recipient.

      The messages are pushed to the subscriber as soon as they arrive.

      Parameters:
      client - listener of messages.

    • unsubscribe

      void unsubscribe(IMessageSubscriber client)
      Unsubscribes a client for a given recipient.
      Parameters:
      client - listener to unsubscribe.