pl.net.bluesoft.rnd.pt.ext.bpmnotifications.service

Class TemplateDataProvider

java.lang.Object

pl.net.bluesoft.rnd.pt.ext.bpmnotifications.service.TemplateDataProvider

All Implemented Interfaces:

IArgumentProviderHandler, ITemplateDataProvider

public class TemplateDataProvider
extends Object
implements ITemplateDataProvider

Data provider for standard e-mail notifications

Author:

mpawlak@bluesoft.net.pl

Field Summary

Fields inherited from interface pl.net.bluesoft.rnd.pt.ext.bpmnotifications.service.ITemplateDataProvider

_ASSIGNEE, _CONFIG, _CONTEXT, _CREATOR, _PROCESS, _PROCESS_ID, _PROCESS_VISIBLE_ID, _SESSION, _TASK, _TASK_LINK, _TASK_NAME, _TASK_URL, _USER

Constructor Summary

Constructors

Constructor and Description
TemplateDataProvider()

Method Summary

Methods

Modifier and Type	Method and Description
TemplateDataProvider	addArgumentProvidersData(TemplateData templateData, BpmNotificationConfig cfg, ProcessInstance pi) Add entries from additional argument providers
TemplateDataProvider	addContextAdditionalData(TemplateData templateData, BpmNotificationConfig cfg, ProcessToolBpmSession bpmSession) Add technical additional data.
TemplateDataProvider	addProcessData(TemplateData templateData, ProcessInstance pi) Add entries: - processVisibleId - processId - process - assignee
ITemplateDataProvider	addTaskData(TemplateData templateData, BpmTask task) Add entries: - task - taskName - taskUrl - taskLink - assignee
TemplateDataProvider	addUserToNotifyData(TemplateData templateData, UserData userToNotify) Add entries: - user
TemplateData	createTemplateData(String templateName, Locale locale) Creates new empty template data object
List<TemplateArgumentDescription>	getDefaultArgumentDescriptions(I18NSource i18NSource) Get default argument descriptions
Collection<TemplateArgumentProvider>	getTemplateArgumentProviders()
void	registerTemplateArgumentProvider(TemplateArgumentProvider provider)
void	unregisterTemplateArgumentProvider(TemplateArgumentProvider provider)

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateDataProvider

public TemplateDataProvider()

Method Detail

createTemplateData

public TemplateData createTemplateData(String templateName,
                              Locale locale)

Creates new empty template data object

Specified by:

createTemplateData in interface ITemplateDataProvider

Returns:

empty data object

addTaskData

public ITemplateDataProvider addTaskData(TemplateData templateData,
                                BpmTask task)

Description copied from interface: ITemplateDataProvider

Add entries: - task - taskName - taskUrl - taskLink - assignee

Specified by:

addTaskData in interface ITemplateDataProvider

addProcessData

public TemplateDataProvider addProcessData(TemplateData templateData,
                                  ProcessInstance pi)

Description copied from interface: ITemplateDataProvider

Add entries: - processVisibleId - processId - process - assignee

Specified by:

addProcessData in interface ITemplateDataProvider

addUserToNotifyData

public TemplateDataProvider addUserToNotifyData(TemplateData templateData,
                                       UserData userToNotify)

Description copied from interface: ITemplateDataProvider

Add entries: - user

Specified by:

addUserToNotifyData in interface ITemplateDataProvider

addContextAdditionalData

public TemplateDataProvider addContextAdditionalData(TemplateData templateData,
                                            BpmNotificationConfig cfg,
                                            ProcessToolBpmSession bpmSession)

Description copied from interface: ITemplateDataProvider

Add technical additional data. This method should be deleted in future refactoring

Specified by:

addContextAdditionalData in interface ITemplateDataProvider

addArgumentProvidersData

public TemplateDataProvider addArgumentProvidersData(TemplateData templateData,
                                            BpmNotificationConfig cfg,
                                            ProcessInstance pi)

Description copied from interface: ITemplateDataProvider

Add entries from additional argument providers

Specified by:

addArgumentProvidersData in interface ITemplateDataProvider

registerTemplateArgumentProvider

public void registerTemplateArgumentProvider(TemplateArgumentProvider provider)

Specified by:

registerTemplateArgumentProvider in interface IArgumentProviderHandler

unregisterTemplateArgumentProvider

public void unregisterTemplateArgumentProvider(TemplateArgumentProvider provider)

Specified by:

unregisterTemplateArgumentProvider in interface IArgumentProviderHandler

getTemplateArgumentProviders

public Collection<TemplateArgumentProvider> getTemplateArgumentProviders()

Specified by:

getTemplateArgumentProviders in interface IArgumentProviderHandler

getDefaultArgumentDescriptions

public List<TemplateArgumentDescription> getDefaultArgumentDescriptions(I18NSource i18NSource)

Description copied from interface: ITemplateDataProvider

Get default argument descriptions

Specified by:

getDefaultArgumentDescriptions in interface ITemplateDataProvider