Package io.jmix.emailtemplates

Interface EmailTemplates

All Known Implementing Classes:

EmailTemplatesImpl

public interface EmailTemplates

That interface provides converting email template EmailTemplate with report parameters to Jmix email info EmailInfo. There are two cases to pass the report parameters. It is map to pass non-repeating parameters for all included reports, and list of wrappers ReportWithParams containing parameters for each report separately. Also interface provides checking that report parameter type ReportInputParameter was changed. It compares with parameter type value saved in ParameterValue entity.

Method Summary

Modifier and Type	Method	Description
EmailTemplateBuilder	buildFromTemplate(EmailTemplate emailTemplate)	That method provides EmailTemplateBuilder fluent builder API for email template.
EmailTemplateBuilder	buildFromTemplate(String code)	That method provides EmailTemplateBuilder fluent builder API by template with unique string code.
void	checkParameterTypeChanged(ReportInputParameter inputParameter, ParameterValue parameterValue)	That method checks that the report input parameter did not change own parameter type
EmailInfo	generateEmail(EmailTemplate emailTemplate, Collection<ReportWithParams> params)	That method creates EmailInfo from template that may contain the same reports with different parameter values.
EmailInfo	generateEmail(EmailTemplate emailTemplate, Map<String,Object> params)	That method creates EmailInfo by template and parameters map for all included reports.
EmailInfo	generateEmail(String emailTemplateCode, Collection<ReportWithParams> params)	That method creates EmailInfo by template with unique string code.
EmailInfo	generateEmail(String emailTemplateCode, Map<String,Object> params)	That method creates EmailInfo by template with unique string code.

Method Details

generateEmail

EmailInfo generateEmail(EmailTemplate emailTemplate,
 Map<String,Object> params)
                 throws TemplateNotFoundException,
ReportParameterTypeChangedException

That method creates EmailInfo by template and parameters map for all included reports.

Parameters:

emailTemplate - EmailTemplate entity containing body and attachments reports

params - map containing parameters for all included reports

Returns:

EmailInfo from Jmix emailer

Throws:

TemplateNotFoundException - If emailTemplate does not contain reports or null

ReportParameterTypeChangedException - If parameter type of inputParameter does not equal to type saved in parameterValue.

generateEmail

EmailInfo generateEmail(EmailTemplate emailTemplate,
 Collection<ReportWithParams> params)
                 throws TemplateNotFoundException,
ReportParameterTypeChangedException

That method creates EmailInfo from template that may contain the same reports with different parameter values.

Parameters:

emailTemplate - EmailTemplate entity containing body and attachments reports

params - ReportWithParams wrapper containing report and its parameters

Returns:

EmailInfo from Jmix emailer

Throws:

TemplateNotFoundException - If emailTemplate does not contain reports or null

ReportParameterTypeChangedException - If parameter type of inputParameter does not equal to type saved in parameterValue.

generateEmail

EmailInfo generateEmail(String emailTemplateCode,
 Map<String,Object> params)
                 throws TemplateNotFoundException,
ReportParameterTypeChangedException

That method creates EmailInfo by template with unique string code.

Parameters:

emailTemplateCode - unique string code of email template

params - map containing parameters for all included reports

Returns:

EmailInfo from Jmix emailer

Throws:

TemplateNotFoundException - If emailTemplate does not contain reports or null

ReportParameterTypeChangedException - If parameter type of inputParameter does not equal to type saved in parameterValue.

generateEmail

EmailInfo generateEmail(String emailTemplateCode,
 Collection<ReportWithParams> params)
                 throws TemplateNotFoundException,
ReportParameterTypeChangedException

That method creates EmailInfo by template with unique string code.

Parameters:

emailTemplateCode - unique string code of email template

params - ReportWithParams wrapper containing report and its parameters

Returns:

EmailInfo from Jmix emailer

Throws:

TemplateNotFoundException - If emailTemplate does not contain reports or null

ReportParameterTypeChangedException - If parameter type of inputParameter does not equal to type saved in parameterValue.

checkParameterTypeChanged

void checkParameterTypeChanged(ReportInputParameter inputParameter,
 ParameterValue parameterValue)
                        throws ReportParameterTypeChangedException

That method checks that the report input parameter did not change own parameter type

Parameters:

inputParameter - ReportInputParameter from Jmix reporting

parameterValue - entity ParameterValue to save report parameter default value

Throws:

ReportParameterTypeChangedException - If parameter type of inputParameter does not equal to type saved in parameterValue.

buildFromTemplate

EmailTemplateBuilder buildFromTemplate(EmailTemplate emailTemplate)

That method provides EmailTemplateBuilder fluent builder API for email template.

Parameters:

emailTemplate - EmailTemplate entity containing body and attachments reports

Returns:

EmailTemplateBuilder fluent template builder API

buildFromTemplate

EmailTemplateBuilder buildFromTemplate(String code)
                                throws TemplateNotFoundException

That method provides EmailTemplateBuilder fluent builder API by template with unique string code.

Parameters:

code - unique string code of email template*

Returns:

EmailTemplateBuilder fluent template builder API

Throws:

TemplateNotFoundException - If emailTemplate does not contain reports or null