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

Interface ITemplateDataProvider

All Superinterfaces:

IArgumentProviderHandler

All Known Implementing Classes:

TemplateDataProvider

public interface ITemplateDataProvider
extends IArgumentProviderHandler

Data provider for e-mail notifications

Author:

mpawlak@bluesoft.net.pl

Field Summary

Fields

Modifier and Type	Field and Description
static String	_ASSIGNEE Current assignee instance (UserData), you can access all process properties if seperatre by dot.
static String	_CONFIG Current template config instance, do not use in template
static String	_CONTEXT Current context instance, do not use in template
static String	_CREATOR Process creator instance (UserData), you can access all process properties if seperatre by dot.
static String	_PROCESS Process instance, you can access all process properties if seperatre by dot.
static String	_PROCESS_ID Process id in database.
static String	_PROCESS_VISIBLE_ID Process visible id, external process key or internal id if external doesn't exist.
static String	_SESSION Current session instance, do not use in template
static String	_TASK If task exists, this is instance of current BpmTask.
static String	_TASK_LINK If task exists, this is url link for webbrowser to this task.
static String	_TASK_NAME If task exists, this is the name of current BpmTask.
static String	_TASK_URL If task exists, this is url link for webbrowser to this task.
static String	_USER Current assignee instance (UserData), you can access all process properties if seperatre by dot.

Method Summary

Methods

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

Methods inherited from interface pl.net.bluesoft.rnd.pt.ext.bpmnotifications.service.IArgumentProviderHandler

getTemplateArgumentProviders, registerTemplateArgumentProvider, unregisterTemplateArgumentProvider

Field Detail

_PROCESS_VISIBLE_ID

static final String _PROCESS_VISIBLE_ID

Process visible id, external process key or internal id if external doesn't exist. Use ${processVisibleId} in template

See Also:

Constant Field Values

_PROCESS_ID

static final String _PROCESS_ID

Process id in database. Use ${processId} in template

See Also:

Constant Field Values

_PROCESS

static final String _PROCESS

Process instance, you can access all process properties if seperatre by dot. Use ${process} in template

See Also:

Constant Field Values

_USER

static final String _USER

Current assignee instance (UserData), you can access all process properties if seperatre by dot. Use ${user} in template

See Also:

Constant Field Values

_CREATOR

static final String _CREATOR

Process creator instance (UserData), you can access all process properties if seperatre by dot. Use ${user} in template

See Also:

Constant Field Values

_SESSION

static final String _SESSION

Current session instance, do not use in template

See Also:

Constant Field Values

_CONTEXT

static final String _CONTEXT

Current context instance, do not use in template

See Also:

Constant Field Values

_CONFIG

static final String _CONFIG

Current template config instance, do not use in template

See Also:

Constant Field Values

_TASK

static final String _TASK

If task exists, this is instance of current BpmTask. Use ${task} in template

See Also:

Constant Field Values

_TASK_NAME

static final String _TASK_NAME

If task exists, this is the name of current BpmTask. Use ${taskName} in template

See Also:

Constant Field Values

_TASK_URL

static final String _TASK_URL

If task exists, this is url link for webbrowser to this task. Use ${taskUrl} in template

See Also:

Constant Field Values

_TASK_LINK

static final String _TASK_LINK

If task exists, this is url link for webbrowser to this task. Use ${taskLink} in template

See Also:

Constant Field Values

_ASSIGNEE

static final String _ASSIGNEE

Current assignee instance (UserData), you can access all process properties if seperatre by dot. Use ${user} in template

See Also:

Constant Field Values

Method Detail

createTemplateData

TemplateData createTemplateData(String templateName,
                              Locale locale)

Create new template data using given locale

Parameters:

templateName -

locale -

Returns:

empty data object

addTaskData

ITemplateDataProvider addTaskData(TemplateData templateData,
                                BpmTask task)

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

addProcessData

ITemplateDataProvider addProcessData(TemplateData templateData,
                                   ProcessInstance pi)

Add entries: - processVisibleId - processId - process - assignee

addUserToNotifyData

ITemplateDataProvider addUserToNotifyData(TemplateData templateData,
                                        UserData userToNotify)

Add entries: - user

addArgumentProvidersData

ITemplateDataProvider addArgumentProvidersData(TemplateData templateData,
                                             BpmNotificationConfig cfg,
                                             ProcessInstance pi)

Add entries from additional argument providers

addContextAdditionalData

ITemplateDataProvider addContextAdditionalData(TemplateData templateData,
                                             BpmNotificationConfig cfg,
                                             ProcessToolBpmSession bpmSession)

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

getDefaultArgumentDescriptions

List<TemplateArgumentDescription> getDefaultArgumentDescriptions(I18NSource i18NSource)

Get default argument descriptions