org.finra.herd.service.activiti

Class ActivitiHelper

java.lang.Object

org.finra.herd.service.activiti.ActivitiHelper

@Component
public class ActivitiHelper
extends Object

A helper bean that provides useful methods for Activiti classes (e.g. interceptors, Java delegates, etc.).

If you want to find common functionality related to Activiti Runtime, then use ActivitiRuntimeHelper.

Constructor Summary

Constructors

Constructor and Description
ActivitiHelper()

Method Summary

Modifier and Type	Method and Description
org.activiti.bpmn.model.BpmnModel	constructBpmnModelFromXmlAndValidate(String xmlString) Constructs BPMN model from the XML string and validates
Object	getExpressionVariable(org.activiti.engine.delegate.Expression expression, org.activiti.engine.delegate.DelegateExecution execution) Gets an expression variable from the execution.
Boolean	getExpressionVariableAsBoolean(org.activiti.engine.delegate.Expression expression, org.activiti.engine.delegate.DelegateExecution execution, String variableName, boolean isRequired, Boolean defaultValue) Gets an expression variable from the execution as a Boolean.
Integer	getExpressionVariableAsInteger(org.activiti.engine.delegate.Expression expression, org.activiti.engine.delegate.DelegateExecution execution, String variableName, boolean isRequired) Gets an expression variable from the execution as Integer.
String	getExpressionVariableAsString(org.activiti.engine.delegate.Expression expression, org.activiti.engine.delegate.DelegateExecution execution) Gets an expression variable from the execution as String.
String	getProcessIdentifyingInformation(org.activiti.engine.delegate.DelegateExecution execution) Gets process identifying information from the current execution as a String.
String	getRequiredExpressionVariableAsString(org.activiti.engine.delegate.Expression expression, org.activiti.engine.delegate.DelegateExecution execution, String variableName) Gets an expression variable from the execution as String.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivitiHelper

public ActivitiHelper()

Method Detail

getProcessIdentifyingInformation

public String getProcessIdentifyingInformation(org.activiti.engine.delegate.DelegateExecution execution)

Gets process identifying information from the current execution as a String.

Parameters:

execution - the execution.

Returns:

the process identifying information.

getExpressionVariable

public Object getExpressionVariable(org.activiti.engine.delegate.Expression expression,
                                    org.activiti.engine.delegate.DelegateExecution execution)

Gets an expression variable from the execution. This method will return null if the expression is null (i.e. when a workflow doesn't define the expression).

Parameters:

expression - the expression variable to get.

execution - the execution that contains the variable value.

Returns:

the variable value or null if the expression is null.

getExpressionVariableAsString

public String getExpressionVariableAsString(org.activiti.engine.delegate.Expression expression,
                                            org.activiti.engine.delegate.DelegateExecution execution)

Gets an expression variable from the execution as String. This method will return null if the expression is null (i.e. when a workflow doesn't define the expression).

Parameters:

expression - the expression variable to get.

execution - the execution that contains the variable value.

Returns:

the variable value or null if the expression is null.

getRequiredExpressionVariableAsString

public String getRequiredExpressionVariableAsString(org.activiti.engine.delegate.Expression expression,
                                                    org.activiti.engine.delegate.DelegateExecution execution,
                                                    String variableName)
                                             throws IllegalArgumentException

Gets an expression variable from the execution as String. This method will throw IllegalArgumentException if the expression is null (i.e. when a workflow doesn't define the expression).

Parameters:

expression - the expression variable to get.

execution - the execution that contains the variable value.

variableName - the name of the variable that is being checked.

Returns:

the variable value.

Throws:

IllegalArgumentException - if variable is not specified.

getExpressionVariableAsInteger

public Integer getExpressionVariableAsInteger(org.activiti.engine.delegate.Expression expression,
                                              org.activiti.engine.delegate.DelegateExecution execution,
                                              String variableName,
                                              boolean isRequired)
                                       throws IllegalArgumentException

Gets an expression variable from the execution as Integer. This method will throw IllegalArgumentException if it is not a valid integer value and is a required variable.

Parameters:

expression - the expression variable to get.

execution - the execution that contains the variable value.

variableName - the variable name

isRequired - whether this variable is required

Returns:

the integer variable value.

Throws:

IllegalArgumentException - if not a valid integer value.

getExpressionVariableAsBoolean

public Boolean getExpressionVariableAsBoolean(org.activiti.engine.delegate.Expression expression,
                                              org.activiti.engine.delegate.DelegateExecution execution,
                                              String variableName,
                                              boolean isRequired,
                                              Boolean defaultValue)
                                       throws IllegalArgumentException

Gets an expression variable from the execution as a Boolean. This method will throw IllegalArgumentException if it is not a valid boolean value and is a required variable.

Parameters:

expression - the expression variable to get.

execution - the execution that contains the variable value.

variableName - the variable name.

isRequired - whether this variable is required.

defaultValue - the default value if variable is null.

Returns:

the Boolean variable value.

Throws:

IllegalArgumentException - if not a valid boolean value.

constructBpmnModelFromXmlAndValidate

public org.activiti.bpmn.model.BpmnModel constructBpmnModelFromXmlAndValidate(String xmlString)
                                                                       throws UnsupportedEncodingException,
                                                                              XMLStreamException

Constructs BPMN model from the XML string and validates

Parameters:

xmlString - the Activiti XML

Returns:

the BPMN Model.

Throws:

UnsupportedEncodingException - if the encoding wasn't supported.

XMLStreamException - if the XML couldn't be streamed.