org.openmrs.api.db
Interface TemplateDAO

All Known Implementing Classes:
HibernateTemplateDAO

public interface TemplateDAO

Message template related database functions

Version:
1.0

Method Summary
 void createTemplate(Template template)
          Create new template.
 void deleteTemplate(Template template)
          Delete existing template.
 Template getTemplate(java.lang.Integer id)
          Get message template by id
 java.util.List<Template> getTemplates()
          Get all message templates
 java.util.List<Template> getTemplatesByName(java.lang.String name)
          Get message template by name
 void updateTemplate(Template template)
          Update existing template.
 

Method Detail

getTemplates

java.util.List<Template> getTemplates()
                                      throws DAOException
Get all message templates

Throws:
DAOException

getTemplate

Template getTemplate(java.lang.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

java.util.List<Template> getTemplatesByName(java.lang.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

OpenMRS-1.7.x

Generated Apr 27 2012 10:06 PM. NOTE - these libraries are in active development and subject to change