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

Interface MessageTemplateManagement

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addTemplate​(pl.edu.icm.unity.types.basic.MessageTemplate toAdd)  
      java.util.Map<java.lang.String,​pl.edu.icm.unity.types.basic.MessageTemplate> getCompatibleTemplates​(java.lang.String templateConsumer)  
      pl.edu.icm.unity.types.basic.MessageTemplate getPreprocessedTemplate​(java.lang.String name)
      Returns a template after pre-processing (e.g. all includes are resolved).
      pl.edu.icm.unity.types.basic.MessageTemplate getPreprocessedTemplate​(pl.edu.icm.unity.types.basic.MessageTemplate toProcess)
      As getPreprocessedTemplate(String) but returns the argument template after preprocessing
      pl.edu.icm.unity.types.basic.MessageTemplate getTemplate​(java.lang.String name)  
      java.util.Map<java.lang.String,​pl.edu.icm.unity.types.basic.MessageTemplate> listTemplates()  
      void reloadFromConfiguration​(java.util.Set<java.lang.String> toReload)  
      void removeTemplate​(java.lang.String name)  
      void updateTemplate​(pl.edu.icm.unity.types.basic.MessageTemplate updated)  

    • 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​(java.lang.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

        java.util.Map<java.lang.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​(java.lang.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​(java.lang.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

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

      • reloadFromConfiguration

        void reloadFromConfiguration​(java.util.Set<java.lang.String> toReload)