Package io.jmix.emailtemplates.impl

Class EmailTemplateBuilderImpl

java.lang.Object

io.jmix.emailtemplates.impl.EmailTemplateBuilderImpl

All Implemented Interfaces:

EmailTemplateBuilder

@Component("emltmp_EmailTemplateBuilder")
@Scope("prototype")
public class EmailTemplateBuilderImpl
extends Object
implements EmailTemplateBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected Emailer	emailer
protected EmailTemplate	emailTemplate
protected EmailTemplates	emailTemplates
protected Metadata	metadata
protected MetadataTools	metadataTools
protected List<ReportWithParams>	reportParams

Constructor Summary

Constructors

Constructor	Description
EmailTemplateBuilderImpl()

Method Summary

Modifier and Type	Method	Description
EmailTemplateBuilder	addAttachmentFile(EmailTemplateAttachment file)	That terminal method fills 'attachedFiles' property of email template EmailTemplate.
EmailTemplateBuilder	addAttachmentReport(Report report)	That terminal method fills 'attachedTemplateReports' property of email template EmailTemplate by one TemplateReport for that report.
EmailTemplateBuilder	addBcc(String bcc)	That terminal method fills 'bcc' property of email template EmailTemplate.
EmailTemplateBuilder	addCc(String cc)	That terminal method fills 'cc' property of email template EmailTemplate.
EmailTemplateBuilder	addTo(String to)	That terminal method fills 'to' property of email template EmailTemplate.
EmailTemplate	build()	That intermediate method creates copy of filled EmailTemplate
protected EmailTemplate	cloneTemplate(EmailTemplate emailTemplate)
EmailInfo	generateEmail()	That intermediate method creates EmailInfo by filled email template using EmailTemplates.
void	sendEmail()	That intermediate method sends filled email template EmailTemplate using Emailer.
void	sendEmail(boolean async)	That intermediate method sends filled email template EmailTemplate using Emailer.
void	sendEmailAsync()	That intermediate method asynchronously sends filled email template EmailTemplate using Emailer.
EmailTemplateBuilder	setAttachmentFiles(List<EmailTemplateAttachment> files)	That terminal method fills 'attachedFiles' property of email template EmailTemplate.
EmailTemplateBuilder	setAttachmentParameter(Report report, String key, Object value)	That terminal method fills 'attachedTemplateReports' property of email template EmailTemplate.
EmailTemplateBuilder	setAttachmentParameters(ReportWithParams reportWithParams)	That terminal method fills 'attachedTemplateReports' property of email template EmailTemplate.
EmailTemplateBuilder	setAttachmentParameters(Report report, Map<String,Object> params)	That terminal method fills 'attachedTemplateReports' property of email template EmailTemplate.
EmailTemplateBuilder	setAttachmentParameters(Collection<ReportWithParams> reportsWithParams)	That terminal method fills 'attachedTemplateReports' property of email template EmailTemplate.
EmailTemplateBuilder	setAttachmentReports(Collection<Report> reports)	That terminal method fills 'attachedTemplateReports' property of email template EmailTemplate by collection of TemplateReport for each reports.
EmailTemplateBuilder	setBcc(String bcc)	That terminal method fills 'bcc' property of email template EmailTemplate.
EmailTemplateBuilder	setBodyParameter(String key, Object value)	That terminal method fills TemplateReport for child entity of email template EmailTemplate.
EmailTemplateBuilder	setBodyParameters(Map<String,Object> params)	That terminal method fills TemplateReport of child entity of email template EmailTemplate.
EmailTemplateBuilder	setCc(String cc)	That terminal method fills 'cc' property of email template EmailTemplate.
void	setEmailTemplate(EmailTemplate emailTemplate)	Clones specified email template and set it for the builder instance
EmailTemplateBuilder	setFrom(String from)	That terminal method fills 'from' property of email template EmailTemplate.
EmailTemplateBuilder	setSubject(String subject)	That terminal method fills subject property of email template EmailTemplate.
EmailTemplateBuilder	setTo(String to)	That terminal method fills 'to' property of email template EmailTemplate.

Methods inherited from class java.lang.Object

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

Field Details

emailTemplate

protected EmailTemplate emailTemplate

reportParams

protected List<ReportWithParams> reportParams

metadata

@Autowired
protected Metadata metadata

emailTemplates

@Autowired
protected EmailTemplates emailTemplates

emailer

@Autowired
protected Emailer emailer

metadataTools

@Autowired
protected MetadataTools metadataTools

Constructor Details

EmailTemplateBuilderImpl

public EmailTemplateBuilderImpl()

Method Details

setEmailTemplate

public void setEmailTemplate(EmailTemplate emailTemplate)

Description copied from interface: EmailTemplateBuilder

Clones specified email template and set it for the builder instance

Specified by:

setEmailTemplate in interface EmailTemplateBuilder

Parameters:

emailTemplate - email template

setSubject

public EmailTemplateBuilder setSubject(String subject)

Description copied from interface: EmailTemplateBuilder

That terminal method fills subject property of email template EmailTemplate.

Specified by:

setSubject in interface EmailTemplateBuilder

Parameters:

subject - String

Returns:

EmailTemplateBuilder

setFrom

public EmailTemplateBuilder setFrom(String from)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'from' property of email template EmailTemplate.

Specified by:

setFrom in interface EmailTemplateBuilder

Parameters:

from - String

Returns:

EmailTemplateBuilder

addTo

public EmailTemplateBuilder addTo(String to)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'to' property of email template EmailTemplate. Addresses is added to already existed by the concatenation with ',' symbol.

Specified by:

addTo in interface EmailTemplateBuilder

Parameters:

to - String

Returns:

EmailTemplateBuilder

setTo

public EmailTemplateBuilder setTo(String to)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'to' property of email template EmailTemplate.

Specified by:

setTo in interface EmailTemplateBuilder

Parameters:

to - String

Returns:

EmailTemplateBuilder

addCc

public EmailTemplateBuilder addCc(String cc)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'cc' property of email template EmailTemplate. Addresses is added to already existed by the concatenation with ',' symbol.

Specified by:

addCc in interface EmailTemplateBuilder

Parameters:

cc - String

Returns:

EmailTemplateBuilder

setCc

public EmailTemplateBuilder setCc(String cc)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'cc' property of email template EmailTemplate.

Specified by:

setCc in interface EmailTemplateBuilder

Parameters:

cc - String

Returns:

EmailTemplateBuilder

addBcc

public EmailTemplateBuilder addBcc(String bcc)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'bcc' property of email template EmailTemplate. Addresses is added to already existed by the concatenation with ',' symbol.

Specified by:

addBcc in interface EmailTemplateBuilder

Parameters:

bcc - String

Returns:

EmailTemplateBuilder

setBcc

public EmailTemplateBuilder setBcc(String bcc)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'bcc' property of email template EmailTemplate.

Specified by:

setBcc in interface EmailTemplateBuilder

Parameters:

bcc - String

Returns:

EmailTemplateBuilder

addAttachmentReport

public EmailTemplateBuilder addAttachmentReport(Report report)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'attachedTemplateReports' property of email template EmailTemplate by one TemplateReport for that report.

Specified by:

addAttachmentReport in interface EmailTemplateBuilder

Parameters:

report - Report

Returns:

EmailTemplateBuilder

setAttachmentReports

public EmailTemplateBuilder setAttachmentReports(Collection<Report> reports)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'attachedTemplateReports' property of email template EmailTemplate by collection of TemplateReport for each reports.

Specified by:

setAttachmentReports in interface EmailTemplateBuilder

Parameters:

reports - collection of Report

Returns:

EmailTemplateBuilder

addAttachmentFile

public EmailTemplateBuilder addAttachmentFile(EmailTemplateAttachment file)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'attachedFiles' property of email template EmailTemplate.

Specified by:

addAttachmentFile in interface EmailTemplateBuilder

Parameters:

file - EmailTemplateAttachment

Returns:

EmailTemplateBuilder

setAttachmentFiles

public EmailTemplateBuilder setAttachmentFiles(List<EmailTemplateAttachment> files)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'attachedFiles' property of email template EmailTemplate.

Specified by:

setAttachmentFiles in interface EmailTemplateBuilder

Parameters:

files - list of EmailTemplateAttachment

Returns:

EmailTemplateBuilder

setAttachmentParameter

public EmailTemplateBuilder setAttachmentParameter(Report report,
 String key,
 Object value)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'attachedTemplateReports' property of email template EmailTemplate. Method removes all TemplateReport with same report if they exist.

Specified by:

setAttachmentParameter in interface EmailTemplateBuilder

Parameters:

report - report

key - String is alias property of ParameterValue

value - Object will be converted to defaultValue property of ParameterValue

Returns:

EmailTemplateBuilder

setAttachmentParameters

public EmailTemplateBuilder setAttachmentParameters(ReportWithParams reportWithParams)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'attachedTemplateReports' property of email template EmailTemplate. Method removes all TemplateReport with same report if they exist.

Specified by:

setAttachmentParameters in interface EmailTemplateBuilder

Parameters:

reportWithParams - ReportWithParams

Returns:

EmailTemplateBuilder

setAttachmentParameters

public EmailTemplateBuilder setAttachmentParameters(Report report,
 Map<String,Object> params)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'attachedTemplateReports' property of email template EmailTemplate. Method removes all TemplateReport with same report if they exist.

Specified by:

setAttachmentParameters in interface EmailTemplateBuilder

Parameters:

report - Report

params - Map

Returns:

EmailTemplateBuilder

setBodyParameter

public EmailTemplateBuilder setBodyParameter(String key,
 Object value)

Description copied from interface: EmailTemplateBuilder

That terminal method fills TemplateReport for child entity of email template EmailTemplate. If there are no reports with parameter with alias 'key', do nothing.

Specified by:

setBodyParameter in interface EmailTemplateBuilder

Parameters:

key - String is alias property of ParameterValue

value - Object will be converted to defaultValue property of ParameterValue

Returns:

EmailTemplateBuilder

setBodyParameters

public EmailTemplateBuilder setBodyParameters(Map<String,Object> params)

Description copied from interface: EmailTemplateBuilder

That terminal method fills TemplateReport of child entity of email template EmailTemplate. If there are no reports with parameter with aliases that contained in key set, do nothing.

Specified by:

setBodyParameters in interface EmailTemplateBuilder

Parameters:

params - Map

Returns:

EmailTemplateBuilder

setAttachmentParameters

public EmailTemplateBuilder setAttachmentParameters(Collection<ReportWithParams> reportsWithParams)

Description copied from interface: EmailTemplateBuilder

That terminal method fills 'attachedTemplateReports' property of email template EmailTemplate. Method removes all TemplateReport with same report if they exist.

Specified by:

setAttachmentParameters in interface EmailTemplateBuilder

Parameters:

reportsWithParams - collection of ReportWithParams

Returns:

EmailTemplateBuilder

generateEmail

public EmailInfo generateEmail()
                        throws ReportParameterTypeChangedException,
TemplateNotFoundException

Description copied from interface: EmailTemplateBuilder

That intermediate method creates EmailInfo by filled email template using EmailTemplates.

Specified by:

generateEmail in interface EmailTemplateBuilder

Returns:

EmailInfo from Jmix emailer

Throws:

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

TemplateNotFoundException - If emailTemplate does not contain reports or null.

build

public EmailTemplate build()

Description copied from interface: EmailTemplateBuilder

That intermediate method creates copy of filled EmailTemplate

Specified by:

build in interface EmailTemplateBuilder

Returns:

EmailTemplate from Jmix emailer

cloneTemplate

protected EmailTemplate cloneTemplate(EmailTemplate emailTemplate)

sendEmail

public void sendEmail()
               throws TemplateNotFoundException,
ReportParameterTypeChangedException,
EmailException

Description copied from interface: EmailTemplateBuilder

That intermediate method sends filled email template EmailTemplate using Emailer.

Specified by:

sendEmail in interface EmailTemplateBuilder

Throws:

TemplateNotFoundException - If emailTemplate does not contain reports or null.

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

EmailException - if an error occurs during email sending

sendEmail

public void sendEmail(boolean async)
               throws TemplateNotFoundException,
ReportParameterTypeChangedException,
EmailException

Description copied from interface: EmailTemplateBuilder

That intermediate method sends filled email template EmailTemplate using Emailer.

Specified by:

sendEmail in interface EmailTemplateBuilder

Parameters:

async - Provides choice of selecting asynchronous option.

Throws:

TemplateNotFoundException - If emailTemplate does not contain reports or null.

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

EmailException - if an error occurs during email sending

sendEmailAsync

public void sendEmailAsync()
                    throws TemplateNotFoundException,
ReportParameterTypeChangedException

Description copied from interface: EmailTemplateBuilder

That intermediate method asynchronously sends filled email template EmailTemplate using Emailer.

Specified by:

sendEmailAsync in interface EmailTemplateBuilder

Throws:

TemplateNotFoundException - If emailTemplate does not contain reports or null.

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