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(MessageTemplate toAdd)
Map<String,MessageTemplate>
getCompatibleTemplates(String templateConsumer)
MessageTemplate
getPreprocessedTemplate(String name)
Returns a template after pre-processing (e.g.MessageTemplate
getPreprocessedTemplate(MessageTemplate toProcess)
AsgetPreprocessedTemplate(String)
but returns the argument template after preprocessingMessageTemplate
getTemplate(String name)
Map<String,MessageTemplate>
listTemplates()
void
reloadFromConfiguration(Set<String> toReload)
void
removeTemplate(String name)
void
updateTemplate(MessageTemplate updated)
-
-
-
Method Detail
-
addTemplate
void addTemplate(MessageTemplate toAdd) throws EngineException
- Throws:
EngineException
-
removeTemplate
void removeTemplate(String name) throws EngineException
- Throws:
EngineException
-
updateTemplate
void updateTemplate(MessageTemplate updated) throws EngineException
- Throws:
EngineException
-
listTemplates
Map<String,MessageTemplate> listTemplates() throws EngineException
- Throws:
EngineException
-
getTemplate
MessageTemplate getTemplate(String name) throws EngineException
- Throws:
EngineException
-
getPreprocessedTemplate
MessageTemplate getPreprocessedTemplate(String name) throws EngineException
Returns a template after pre-processing (e.g. all includes are resolved).- Parameters:
name
-- Returns:
- Throws:
EngineException
-
getPreprocessedTemplate
MessageTemplate getPreprocessedTemplate(MessageTemplate toProcess) throws EngineException
AsgetPreprocessedTemplate(String)
but returns the argument template after preprocessing- Parameters:
toProcess
-- Returns:
- Throws:
EngineException
-
getCompatibleTemplates
Map<String,MessageTemplate> getCompatibleTemplates(String templateConsumer) throws EngineException
- Throws:
EngineException
-
-