com.haulmont.bpm.core

Interface ProcessMessagesManager

All Known Implementing Classes:

ProcessMessagesManagerBean

public interface ProcessMessagesManager

Class is used for working with localization messages defined in process

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
void	clearCaches() Clears messages caches
java.lang.String	findMessage(java.lang.String actProcessDefinitionId, java.lang.String key) Returns localized message from BPMN process or null if not found. Locale is determined by the current user session.
java.lang.String	findMessage(java.lang.String actProcessDefinitionId, java.lang.String key, java.util.Locale locale) Returns localized message from BPMN process or null if not found.
java.lang.String	getMessage(java.lang.String actProcessDefinitionId, java.lang.String key) Returns localized message from BPMN process. Locale is determined by the current user session.
java.lang.String	getMessage(java.lang.String actProcessDefinitionId, java.lang.String key, java.util.Locale locale) Returns localized message from BPMN process.
java.lang.String	loadString(java.lang.String actProcessDefinitionId, java.lang.String ref) Get localized message from a process by reference provided in the full format. Locale is determined by the current user session.
java.lang.String	loadString(java.lang.String actProcessDefinitionId, java.lang.String ref, java.util.Locale locale) Get localized message from a process by reference provided in the full format.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getMessage

java.lang.String getMessage(java.lang.String actProcessDefinitionId,
                            java.lang.String key)

Returns localized message from BPMN process.
Locale is determined by the current user session.

Parameters:

actProcessDefinitionId - activiti process definition id

key - message key

Returns:

localized message or the key if the message not found

getMessage

java.lang.String getMessage(java.lang.String actProcessDefinitionId,
                            java.lang.String key,
                            java.util.Locale locale)

Returns localized message from BPMN process.

Parameters:

actProcessDefinitionId - activiti process definition id

key - message key

locale - message locale

Returns:

localized message or the key if the message not found

findMessage

@Nullable
java.lang.String findMessage(java.lang.String actProcessDefinitionId,
                                       java.lang.String key)

Returns localized message from BPMN process or null if not found.
Locale is determined by the current user session.

Parameters:

actProcessDefinitionId - activiti process definition id

key - message key

Returns:

localized message or the key if the message not found

findMessage

@Nullable
java.lang.String findMessage(java.lang.String actProcessDefinitionId,
                                       java.lang.String key,
                                       java.util.Locale locale)

Returns localized message from BPMN process or null if not found.

Parameters:

actProcessDefinitionId - activiti process definition id

key - message key

locale - message locale

Returns:

localized message or the key if the message not found

loadString

java.lang.String loadString(java.lang.String actProcessDefinitionId,
                            java.lang.String ref)

Get localized message from a process by reference provided in the full format.
Locale is determined by the current user session.

Parameters:

actProcessDefinitionId - activiti process definition id

ref - reference to message in the following format: msg://message_key

Returns:

localized message or input string itself if it doesn't begin with msg://

loadString

java.lang.String loadString(java.lang.String actProcessDefinitionId,
                            java.lang.String ref,
                            java.util.Locale locale)

Get localized message from a process by reference provided in the full format.

Parameters:

actProcessDefinitionId - activiti process definition id

ref - reference to message in the following format: msg://message_key

locale - message locale

Returns:

localized message or input string itself if it doesn't begin with msg://

clearCaches

void clearCaches()

Clears messages caches