Package com.logicaldoc.gui.frontend.client.services

Interface MessageService

All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
All Known Implementing Classes:
MessageServiceImpl
@RemoteServiceRelativePath("message") public interface MessageService extends com.google.gwt.user.client.rpc.RemoteService
The client side stub for the Message Service.
Since:
6.0
Author:
Marco Meschieri - LogicalDOC

  • Method Details

    • getMessage

      GUIMessage getMessage(long messageId, boolean markAsRead) throws ServerException
      Gets the Message
      Parameters:
      messageId - identifier of the message
      markAsRead - flag to mark the message as read
      Returns:
      the message instance
      Throws:
      ServerException - an error happened in the server application

    • delete

      void delete(long[] ids) throws ServerException
      Deletes a list of Messages
      Parameters:
      ids - identifiers of the messages
      Throws:
      ServerException - an error happened in the server application

    • save

      void save(GUIMessage message, long[] recipientIds) throws ServerException
      Throws:
      ServerException

    • loadTemplates

      GUIMessageTemplate[] loadTemplates(String language, String type) throws ServerException
      Loads the templates configured for a given language and type
      Parameters:
      language - the language of the template
      type - the type of the template
      Returns:
      the list of templates loaded by the server application
      Throws:
      ServerException - an error happened in the server application

    • getTemplate

      GUIMessageTemplate getTemplate(long templateId) throws ServerException
      Gets the template
      Parameters:
      templateId - identifier of the message template
      Returns:
      the template definition
      Throws:
      ServerException - an error happened in the server application

    • saveTemplates

      void saveTemplates(GUIMessageTemplate[] templates) throws ServerException
      Saves the given templates
      Parameters:
      templates - the templates to save
      Throws:
      ServerException - an error happened in the server application

    • deleteTemplates

      void deleteTemplates(long[] ids) throws ServerException
      Deletes a selection of templates
      Parameters:
      ids - identifiers of the templates to delete
      Throws:
      ServerException - an error happened in the server application

    • deleteTemplates

      void deleteTemplates(String name) throws ServerException
      Deletes the templates with the given name
      Parameters:
      name - name of the templates to delete
      Throws:
      ServerException - an error happened in the server application