Package io.jmix.emailtemplates.impl

Class EmailTemplatesImpl

java.lang.Object

io.jmix.emailtemplates.impl.EmailTemplatesImpl

All Implemented Interfaces:

EmailTemplates

@Component("emltmp_EmailTemplates")
public class EmailTemplatesImpl
extends Object
implements EmailTemplates

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected FileStorageLocator	fileStorageLocator
protected Metadata	metadata
protected ReportRunner	reportRunner
protected TemplateConverter	templateConverter

Constructor Summary

Constructors

Constructor	Description
EmailTemplatesImpl()

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
protected EmailAttachment	createEmailAttachment(String templateName, ReportWithParams reportWithParams)
protected ReportWithParams	createParamsMapForReport(Report report, Map<String,Object> params)
protected List<EmailAttachment>	createReportAttachments(Map<TemplateReport,ReportWithParams> reportsWithParams)
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.
protected EmailInfo	generateEmailInfoWithoutAttachments(ReportWithParams reportWithParams)
protected EmailTemplateBuilder	getEmailTemplateBuilder(EmailTemplate emailTemplate)
protected EmailTemplate	getEmailTemplateByCode(String emailTemplateCode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

reportRunner

@Autowired
protected ReportRunner reportRunner

fileStorageLocator

@Autowired
protected FileStorageLocator fileStorageLocator

templateConverter

@Autowired
protected TemplateConverter templateConverter

applicationContext

@Autowired
protected org.springframework.context.ApplicationContext applicationContext

metadata

@Autowired
protected Metadata metadata

Constructor Details

EmailTemplatesImpl

public EmailTemplatesImpl()

Method Details

generateEmail

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

Description copied from interface: EmailTemplates

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

Specified by:

generateEmail in interface EmailTemplates

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

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

Description copied from interface: EmailTemplates

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

Specified by:

generateEmail in interface EmailTemplates

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

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

Description copied from interface: EmailTemplates

That method creates EmailInfo by template with unique string code.

Specified by:

generateEmail in interface EmailTemplates

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

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

Description copied from interface: EmailTemplates

That method creates EmailInfo by template with unique string code.

Specified by:

generateEmail in interface EmailTemplates

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.

getEmailTemplateByCode

protected EmailTemplate getEmailTemplateByCode(String emailTemplateCode)
                                        throws TemplateNotFoundException

Throws:

TemplateNotFoundException

checkParameterTypeChanged

public void checkParameterTypeChanged(ReportInputParameter inputParameter,
 ParameterValue parameterValue)
                               throws ReportParameterTypeChangedException

Description copied from interface: EmailTemplates

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

Specified by:

checkParameterTypeChanged in interface EmailTemplates

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

public EmailTemplateBuilder buildFromTemplate(EmailTemplate emailTemplate)

Description copied from interface: EmailTemplates

That method provides EmailTemplateBuilder fluent builder API for email template.

Specified by:

buildFromTemplate in interface EmailTemplates

Parameters:

emailTemplate - EmailTemplate entity containing body and attachments reports

Returns:

EmailTemplateBuilder fluent template builder API

buildFromTemplate

public EmailTemplateBuilder buildFromTemplate(String code)
                                       throws TemplateNotFoundException

Description copied from interface: EmailTemplates

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

Specified by:

buildFromTemplate in interface EmailTemplates

Parameters:

code - unique string code of email template*

Returns:

EmailTemplateBuilder fluent template builder API

Throws:

TemplateNotFoundException - If emailTemplate does not contain reports or null

getEmailTemplateBuilder

protected EmailTemplateBuilder getEmailTemplateBuilder(EmailTemplate emailTemplate)

generateEmailInfoWithoutAttachments

protected EmailInfo generateEmailInfoWithoutAttachments(ReportWithParams reportWithParams)

createReportAttachments

protected List<EmailAttachment> createReportAttachments(Map<TemplateReport,ReportWithParams> reportsWithParams)

createEmailAttachment

protected EmailAttachment createEmailAttachment(String templateName,
 ReportWithParams reportWithParams)

createParamsMapForReport

protected ReportWithParams createParamsMapForReport(Report report,
 Map<String,Object> params)