Package pl.edu.icm.unity.engine.api

Interface MessageTemplateManagement

  • public interface MessageTemplateManagement
    This interface allows clients to manipulate message templates.
    Author:
    P. Piernik

    • Method Detail

      • addTemplate

        void addTemplate​(pl.edu.icm.unity.types.basic.MessageTemplate toAdd)
          throws pl.edu.icm.unity.exceptions.EngineException
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • removeTemplate

        void removeTemplate​(String name)
             throws pl.edu.icm.unity.exceptions.EngineException
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • updateTemplate

        void updateTemplate​(pl.edu.icm.unity.types.basic.MessageTemplate updated)
             throws pl.edu.icm.unity.exceptions.EngineException
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • listTemplates

        Map<String,​pl.edu.icm.unity.types.basic.MessageTemplate> listTemplates()
                                                                      throws pl.edu.icm.unity.exceptions.EngineException
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • getTemplate

        pl.edu.icm.unity.types.basic.MessageTemplate getTemplate​(String name)
                                                  throws pl.edu.icm.unity.exceptions.EngineException
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • getPreprocessedTemplate

        pl.edu.icm.unity.types.basic.MessageTemplate getPreprocessedTemplate​(String name)
                                                              throws pl.edu.icm.unity.exceptions.EngineException
        Returns a template after pre-processing (e.g. all includes are resolved).
        Parameters:
        name -
        Returns:
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • getPreprocessedTemplate

        pl.edu.icm.unity.types.basic.MessageTemplate getPreprocessedTemplate​(pl.edu.icm.unity.types.basic.MessageTemplate toProcess)
                                                              throws pl.edu.icm.unity.exceptions.EngineException
        As getPreprocessedTemplate(String) but returns the argument template after preprocessing
        Parameters:
        toProcess -
        Returns:
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • getCompatibleTemplates

        Map<String,​pl.edu.icm.unity.types.basic.MessageTemplate> getCompatibleTemplates​(String templateConsumer)
                                                                               throws pl.edu.icm.unity.exceptions.EngineException
        Throws:
        pl.edu.icm.unity.exceptions.EngineException

      • reloadFromConfiguration

        void reloadFromConfiguration​(Set<String> toReload)