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

Modifier and Type	Method	Description
void	addTemplate(pl.edu.icm.unity.base.msg_template.MessageTemplate toAdd)
Map<String,pl.edu.icm.unity.base.msg_template.MessageTemplate>	getCompatibleTemplates(String templateConsumer)
Set<String>	getMessagesTemplatesFromConfiguration()
pl.edu.icm.unity.base.msg_template.MessageTemplate	getPreprocessedTemplate(String name)	Returns a template after pre-processing (e.g.
pl.edu.icm.unity.base.msg_template.MessageTemplate	getPreprocessedTemplate(pl.edu.icm.unity.base.msg_template.MessageTemplate toProcess)	As getPreprocessedTemplate(String) but returns the argument template after preprocessing
pl.edu.icm.unity.base.msg_template.MessageTemplate	getTemplate(String name)
Map<String,pl.edu.icm.unity.base.msg_template.MessageTemplate>	listTemplates()
void	reloadFromConfiguration(Set<String> toReload)
void	removeTemplate(String name)
void	updateTemplate(pl.edu.icm.unity.base.msg_template.MessageTemplate updated)

Method Details

addTemplate

void addTemplate(pl.edu.icm.unity.base.msg_template.MessageTemplate toAdd)
          throws pl.edu.icm.unity.base.exceptions.EngineException

Throws:

pl.edu.icm.unity.base.exceptions.EngineException

removeTemplate

void removeTemplate(String name)
             throws pl.edu.icm.unity.base.exceptions.EngineException

Throws:

pl.edu.icm.unity.base.exceptions.EngineException

updateTemplate

void updateTemplate(pl.edu.icm.unity.base.msg_template.MessageTemplate updated)
             throws pl.edu.icm.unity.base.exceptions.EngineException

Throws:

pl.edu.icm.unity.base.exceptions.EngineException

listTemplates

Map<String,pl.edu.icm.unity.base.msg_template.MessageTemplate> listTemplates()
                                                                      throws pl.edu.icm.unity.base.exceptions.EngineException

Throws:

pl.edu.icm.unity.base.exceptions.EngineException

getTemplate

pl.edu.icm.unity.base.msg_template.MessageTemplate getTemplate(String name)
                                                        throws pl.edu.icm.unity.base.exceptions.EngineException

Throws:

pl.edu.icm.unity.base.exceptions.EngineException

getPreprocessedTemplate

pl.edu.icm.unity.base.msg_template.MessageTemplate getPreprocessedTemplate(String name)
                                                                    throws pl.edu.icm.unity.base.exceptions.EngineException

Returns a template after pre-processing (e.g. all includes are resolved).

Parameters:

name -

Returns:

Throws:

pl.edu.icm.unity.base.exceptions.EngineException

getPreprocessedTemplate

pl.edu.icm.unity.base.msg_template.MessageTemplate getPreprocessedTemplate(pl.edu.icm.unity.base.msg_template.MessageTemplate toProcess)
                                                                    throws pl.edu.icm.unity.base.exceptions.EngineException

As getPreprocessedTemplate(String) but returns the argument template after preprocessing

Parameters:

toProcess -

Returns:

Throws:

pl.edu.icm.unity.base.exceptions.EngineException

getCompatibleTemplates

Map<String,pl.edu.icm.unity.base.msg_template.MessageTemplate> getCompatibleTemplates(String templateConsumer)
                                                                               throws pl.edu.icm.unity.base.exceptions.EngineException

Throws:

pl.edu.icm.unity.base.exceptions.EngineException

getMessagesTemplatesFromConfiguration

Set<String> getMessagesTemplatesFromConfiguration()

reloadFromConfiguration

void reloadFromConfiguration(Set<String> toReload)