Package io.jmix.emailtemplates

Interface EmailTemplateBuilder

All Known Implementing Classes:

EmailTemplateBuilderImpl

public interface EmailTemplateBuilder

That interface provides abilities of builder pattern to create filled email template EmailTemplate. There are a lot of 'set' and 'add' intermediate methods and five terminal methods. The implementation must contain copy of email template that have to filled by terminal methods.

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
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.

Method Details

setEmailTemplate

void setEmailTemplate(EmailTemplate emailTemplate)

Clones specified email template and set it for the builder instance

Parameters:

emailTemplate - email template

setSubject

EmailTemplateBuilder setSubject(String subject)

That terminal method fills subject property of email template EmailTemplate.

Parameters:

subject - String

Returns:

EmailTemplateBuilder

setFrom

EmailTemplateBuilder setFrom(String from)

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

Parameters:

from - String

Returns:

EmailTemplateBuilder

addTo

EmailTemplateBuilder addTo(String to)

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

Parameters:

to - String

Returns:

EmailTemplateBuilder

setTo

EmailTemplateBuilder setTo(String to)

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

Parameters:

to - String

Returns:

EmailTemplateBuilder

addCc

EmailTemplateBuilder addCc(String cc)

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

Parameters:

cc - String

Returns:

EmailTemplateBuilder

setCc

EmailTemplateBuilder setCc(String cc)

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

Parameters:

cc - String

Returns:

EmailTemplateBuilder

addBcc

EmailTemplateBuilder addBcc(String bcc)

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

Parameters:

bcc - String

Returns:

EmailTemplateBuilder

setBcc

EmailTemplateBuilder setBcc(String bcc)

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

Parameters:

bcc - String

Returns:

EmailTemplateBuilder

addAttachmentReport

EmailTemplateBuilder addAttachmentReport(Report report)

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

Parameters:

report - Report

Returns:

EmailTemplateBuilder

setAttachmentReports

EmailTemplateBuilder setAttachmentReports(Collection<Report> reports)

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

Parameters:

reports - collection of Report

Returns:

EmailTemplateBuilder

addAttachmentFile

EmailTemplateBuilder addAttachmentFile(EmailTemplateAttachment file)

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

Parameters:

file - EmailTemplateAttachment

Returns:

EmailTemplateBuilder

setAttachmentFiles

EmailTemplateBuilder setAttachmentFiles(List<EmailTemplateAttachment> files)

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

Parameters:

files - list of EmailTemplateAttachment

Returns:

EmailTemplateBuilder

setBodyParameter

EmailTemplateBuilder setBodyParameter(String key,
 Object value)

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

Parameters:

key - String is alias property of ParameterValue

value - Object will be converted to defaultValue property of ParameterValue

Returns:

EmailTemplateBuilder

setBodyParameters

EmailTemplateBuilder setBodyParameters(Map<String,Object> params)

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.

Parameters:

params - Map

Returns:

EmailTemplateBuilder

setAttachmentParameter

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

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

Parameters:

report - report

key - String is alias property of ParameterValue

value - Object will be converted to defaultValue property of ParameterValue

Returns:

EmailTemplateBuilder

setAttachmentParameters

EmailTemplateBuilder setAttachmentParameters(ReportWithParams reportWithParams)

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

Parameters:

reportWithParams - ReportWithParams

Returns:

EmailTemplateBuilder

setAttachmentParameters

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

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

Parameters:

report - Report

params - Map

Returns:

EmailTemplateBuilder

setAttachmentParameters

EmailTemplateBuilder setAttachmentParameters(Collection<ReportWithParams> reportsWithParams)

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

Parameters:

reportsWithParams - collection of ReportWithParams

Returns:

EmailTemplateBuilder

generateEmail

EmailInfo generateEmail()
                 throws ReportParameterTypeChangedException,
TemplateNotFoundException

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

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

EmailTemplate build()

That intermediate method creates copy of filled EmailTemplate

Returns:

EmailTemplate from Jmix emailer

sendEmail

void sendEmail()
        throws TemplateNotFoundException,
ReportParameterTypeChangedException,
EmailException

That intermediate method sends filled email template EmailTemplate using 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.

EmailException - if an error occurs during email sending

sendEmail

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

That intermediate method sends filled email template EmailTemplate using Emailer.

Parameters:

async - Provides choice of selecting asynchronous option.

Throws:

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

TemplateNotFoundException - If emailTemplate does not contain reports or null.

EmailException - if an error occurs during email sending

sendEmailAsync

void sendEmailAsync()
             throws TemplateNotFoundException,
ReportParameterTypeChangedException

That intermediate method asynchronously sends filled email template EmailTemplate using 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.