org.openmrs.api.db

Interface TemplateDAO

All Known Implementing Classes:

HibernateTemplateDAO

public interface TemplateDAO

Message template related database functions

Version:

1.0

Method Summary

Modifier and Type	Method and Description
void	createTemplate(Template template) Create new template.
void	deleteTemplate(Template template) Delete existing template.
Template	getTemplate(Integer id) Get message template by id
List<Template>	getTemplates() Get all message templates
List<Template>	getTemplatesByName(String name) Get message template by name
void	updateTemplate(Template template) Update existing template.

Method Detail

getTemplates

List<Template> getTemplates()
                     throws DAOException

Get all message templates

Throws:

DAOException

getTemplate

Template getTemplate(Integer id)
              throws DAOException

Get message template by id

Parameters:

id - internal message template identifier

Returns:

message template with given internal identifier

Throws:

DAOException

getTemplatesByName

List<Template> getTemplatesByName(String name)
                           throws DAOException

Get message template by name

Parameters:

name - message template name

Returns:

message template with given name

Throws:

DAOException

createTemplate

void createTemplate(Template template)
             throws DAOException

Create new template.

Parameters:

template -

Throws:

DAOException

updateTemplate

void updateTemplate(Template template)
             throws DAOException

Update existing template.

Parameters:

template -

Throws:

DAOException

deleteTemplate

void deleteTemplate(Template template)
             throws DAOException

Delete existing template.

Parameters:

template -

Throws:

DAOException