ActivityData

java.lang.Object
- de.aristaflow.adept2.model.runtimeenvironment.ActivityData

```
public class ActivityData
extends java.lang.Object
```
ActivityData provides convenience methods for retrieval of input and output parameter types and values as well as writing the output parameter values. User-defined data types can be lists or other POJOs. Besides the parameters, there are also methods for accessing the configuration values. Mandatory parameters can be checked for existence. If problems occur when accessing a parameter or configuration value, an appropriate ApplicationEnvironmentException will be thrown. This applies for instance in case a mandatory value is not set or a required value has the wrong type.
Besides the specific methods, most convenience methods can be classified into the following groups:
- readInput*: Gets the value of the corresponding input parameter or null in case the value has not been set. No conversion takes place, if the parameter is of the wrong type or does not exist, an exception will be thrown.
- requireInput*: The same as the corresponding readInput*-method but this time an exception will be thrown, if the value is not present.
- *ToNativeTypedValue: These methods are called when you request a value with conversion (@see getInputValue(ProcessModelParameter, boolean, boolean), getStoredValue(String) and getStoredValue(ProcessModelParameter, boolean)). Override this methods to change the type conversion.
- readOutput*: Gets the value of the corresponding output parameter if it has already been written, either by the current execution or by a previous suspended execution. null will be returned if no value has been written. No conversion takes place, if the parameter is of the wrong type or does not exist, an exception will be thrown.
- writeOutput*: Writes the designated value to the corresponding output parameter. No conversion takes place, if the parameter is of the wrong type or does not exist, an exception will be thrown.
- objectTo*: These methods are called when you write a value with conversion (@see writeOutputValue(ProcessModelParameter, boolean, Object)). Override this methods to change the type conversion.
- getConf*: Gets the value of the corresponding activity configuration value. If the configuration value does not exist, or is of another type, the designated default value will be returned.
- requireConf*:: The same as the corresponding getConf*-method but this time an exception will be thrown, if the value is not present or the configuration entry has the wrong type.
- getParamConf*: The same as the getConf* but this time for values of the configuration of the corresponding parameter.
- requireParamConf*: The same as the requireConf* but this time for values of the configuration of the corresponding parameter.
Author:

Ulrich Kreher, Patrick Schmidt, Marco Waimer

Field Summary

Fields
Modifier and Type	Field and Description
`protected ActivityInstance`	`activityInstance` The activity (instance) which is encapsulated by the execution environment.
`protected DataContext`	`dataContext` The data context for the execution environment.
`protected java.util.logging.Logger`	`logger` The logger for execution environment.

Constructor Summary

Constructors
Constructor and Description
`ActivityData(ActivityInstance activityInstance, DataContext dataContext, java.util.logging.Logger logger)` Initialise `activityInstance`, `dataContext` and `logger`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`booleanToNativeTypedValue(java.lang.Boolean value, ProcessModelParameter parameter, boolean output)` Converts an instance of `Boolean` to an instance of the corresponding native type.
`java.lang.Object`	`dateToNativeTypedValue(java.util.Date value, ProcessModelParameter parameter, boolean output)` Converts an instance of `Date` to an instance of the corresponding native type.
`java.lang.Object`	`floatToNativeTypedValue(java.lang.Double value, ProcessModelParameter parameter, boolean output)` Converts an instance of `Double` to an instance of the corresponding native type.
`protected java.lang.Object`	`getActInstConfValue(java.lang.String entryName, ProcessConstants.AdeptDataType expDt, boolean required, java.lang.Object defValue)` Gets the designated activity instance configuration value and logs messages or throws exceptions if it is not present.
`java.util.Collection<java.lang.String>`	`getAllConfEntries()` Returns all configuration entry names.
`java.lang.Boolean`	`getConfBoolean(java.lang.String entryName)` Returns the configuration value of the specified entry or `null` if it is not set.
`java.lang.Boolean`	`getConfBoolean(java.lang.String entryName, java.lang.Boolean defaultValue)` Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as BOOLEAN.
`java.util.Date`	`getConfDate(java.lang.String entryName)` Returns the configuration value of the specified entry or `null` if it is not set.
`java.util.Date`	`getConfDate(java.lang.String entryName, java.util.Date defaultValue)` Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as DATE.
`java.lang.Double`	`getConfFloat(java.lang.String entryName)` Returns the configuration value of the specified entry or the given value if it is not set or could not be parsed as FLOAT.
`java.lang.Double`	`getConfFloat(java.lang.String entryName, java.lang.Double defaultValue)` Returns the configuration value of the specified entry or the given value if it is not set or could not be parsed as FLOAT.
`java.lang.Long`	`getConfInteger(java.lang.String entryName)` Returns the configuration value of the specified entry or `null` if it is not set.
`java.lang.Long`	`getConfInteger(java.lang.String entryName, java.lang.Long defaultValue)` Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as INTEGER.
`java.lang.String`	`getConfString(java.lang.String entryName)` Returns the configuration value of the specified entry or `null` if it is not set.
`java.lang.String`	`getConfString(java.lang.String entryName, java.lang.String defaultValue)` Returns the configuration value of the specified entry or the given default value if it is not set.
`byte[]`	`getConfUDT(java.lang.String entryName)` Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as USERDEFINED.
`byte[]`	`getConfUDT(java.lang.String entryName, byte[] defaultValue)` Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as USERDEFINED.
`java.net.URI`	`getConfURI(java.lang.String entryName)` Returns the configuration value of the specified entry or `null` if it is not set.
`java.net.URI`	`getConfURI(java.lang.String entryName, java.net.URI defaultValue)` Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as URI.
`protected java.lang.Object`	`getConfValue(Configuration conf, java.lang.String entryName, ProcessConstants.AdeptDataType expDt, boolean required, java.lang.Object defValue, java.lang.String paramText)` Gets the designated configuration value and logs messages or throws exceptions if it is not present.
`java.lang.Class<?>`	`getCorrespondingJavaClass(Parameter parameter, boolean output)` Gets the class object corresponding to the type of the designated parameter.
`<T> T`	`getDualInputValue(java.lang.String name, ProcessConstants.AdeptDataType type, java.lang.Class<T> valueType)` A "dual input parameter" is a parameter whose value can either be provided by an input parameter or by an activity configuration field with the same name or a combination of both.
`ProcessModelParameter`	`getInputParam(java.lang.String parameterName)` Returns the input parameter with the given name or `null` if no such parameter exists.
`java.util.Collection<ProcessModelParameter>`	`getInputParams()` Returns all input parameters in a list.
`java.lang.Class<?>[]`	`getInputTypes()` Gets the input parameter types in an array of the corresponding classes ordered by their position.
`java.lang.Object`	`getInputValue(ProcessModelParameter param, boolean convert, boolean required)` Retrieves the value of the specified input parameter as an object of the closest related java type or the appropriate converted type.
`java.lang.Object`	`getInputValue(java.lang.String parameterName)` Retrieves the value of the specified input parameter as an object of the closest related java type.
`java.lang.Object`	`getInputValue(java.lang.String parameterName, boolean required)` Retrieves the value of the specified input parameter as an object of the closest related java type.
`protected java.lang.Object`	`getInputValue(java.lang.String parameterName, ProcessConstants.AdeptDataType expDt, boolean convert, boolean required)` Retrieves the value of the specified input parameter as an object of the closest related java type.
`java.lang.Object[]`	`getInputValues()` Gets the values of the input parameter in an array of object ordered by their position.
`ProcessModelParameter`	`getOutputParam(java.lang.String parameterName)` Returns the output parameter with the given name or `null` if no such parameter exists.
`java.util.Collection<ProcessModelParameter>`	`getOutputParams()` Returns all output parameters in a list.
`java.lang.Boolean`	`getParamConfBoolean(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName, java.lang.Boolean defaultValue)` Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as BOOLEAN.
`java.util.Date`	`getParamConfDate(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName, java.util.Date defaultValue)` Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as DATE.
`java.lang.Double`	`getParamConfFloat(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName, java.lang.Double defaultValue)` Returns the configuration value of the specified entry or the given value if it is not set or could not be parsed as FLOAT.
`java.lang.Long`	`getParamConfInteger(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName, java.lang.Long defaultValue)` Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as INTEGER.
`java.lang.String`	`getParamConfString(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName, java.lang.String defaultValue)` Returns the configuration value of the specified entry or `null` if it is not set.
`byte[]`	`getParamConfUDT(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName, byte[] defaultValue)` Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as USERDEFINED.
`java.net.URI`	`getParamConfURI(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName, java.net.URI defaultValue)` Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as URI.
`protected java.lang.Object`	`getParamConfValue(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName, ProcessConstants.AdeptDataType expDt, boolean required, java.lang.Object defValue)` Gets the designated parameter configuration value and logs messages or throws exceptions if it is not present.
`static java.util.Deque<ProcessModelParameter>`	`getParametersSortedByPosition(java.util.Collection<? extends ProcessModelParameter> params)` Gets the designated parameters sorted by the configured position.
`java.lang.Object`	`getStoredValue(ProcessModelParameter param, boolean convert)` Retrieves the stored value of the specified output parameter as an object of the closest related java type or the appropriate converted type.
`java.lang.Object`	`getStoredValue(java.lang.String parameterName)` Retrieves the stored value of the specified output parameter as an object of the closest related java type.
`protected java.lang.Object`	`getStoredValue(java.lang.String parameterName, ProcessConstants.AdeptDataType expDt, boolean convert)` Retrieves the stored value of the specified output parameter as an object of the closest related java type.
`java.lang.Object[]`	`getStoredValues()` Gets the stored values of the output parameter in an array of object ordered by their position.
`boolean`	`hasConf(java.lang.String entryName)` Returns whether the specified configuration entry is set.
`boolean`	`hasInputListParam(java.lang.String parameterName, ProcessConstants.AdeptDataType elementDataType)` Returns whether the input parameter with the specified name exists and is a list with the specified element type.
`boolean`	`hasInputParam(java.lang.String parameterName)` Returns whether the input parameter with the specified name exists.
`boolean`	`hasInputValue(java.lang.String paramName)` Checks whether the value of the specified input parameter is set, i.e. is not null.
`boolean`	`hasOutputParam(java.lang.String parameterName)` Returns whether the output parameter with the specified name exists.
`boolean`	`hasParam(java.lang.String parameterName, ActivityConstants.AccessType accessType)` Returns whether the parameter with the specified name and access type exists.
`boolean`	`hasParamConf(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName)` Returns whether the specified configuration entry is set.
`java.lang.Object`	`integerToNativeTypedValue(java.lang.Long value, ProcessModelParameter parameter, boolean output)` Converts an instance of `Long` to an instance of the corresponding native type.
`java.lang.Boolean`	`objectToBoolean(java.lang.Object value, ProcessModelParameter parameter, boolean output)` Converts an object (of native type) to an instance of `Boolean`.
`java.util.Date`	`objectToDate(java.lang.Object value, ProcessModelParameter parameter, boolean output)` Converts an object (of native type) to an instance of `Date`.
`java.lang.Double`	`objectToFloat(java.lang.Object value, ProcessModelParameter parameter, boolean output)` Converts an object (of native type) to an instance of `Double`.
`java.lang.Long`	`objectToInteger(java.lang.Object value, ProcessModelParameter parameter, boolean output)` Converts an object (of native type) to an instance of `Long`.
`java.lang.String`	`objectToString(java.lang.Object value, ProcessModelParameter parameter, boolean output)` Converts an object (of native type) to an instance of `String`.
`java.net.URI`	`objectToUri(java.lang.Object value, ProcessModelParameter parameter, boolean output)` Converts an object (of native type) to an instance of `URI`.
`UDTValue`	`objectToUserdefined(java.lang.Object value, ProcessModelParameter parameter, boolean output)` Converts an object to an instance of `UDTValue` by serialising the object and encapsulating the corresponding stream in the returned instance of UDTValue.
`java.lang.Boolean`	`readInputBoolean(java.lang.String parameterName)` Returns the value of the specified BOOLEAN input parameter or `null` if no value is set or the parameter does not exist.
`java.util.Date`	`readInputDate(java.lang.String parameterName)` Returns the value of the specified DATE input parameter or `null` if no value is set or the parameter does not exist.
`java.lang.Double`	`readInputFloat(java.lang.String parameterName)` Returns the value of the specified FLOAT input parameter or `null` if no value is set or the parameter does not exist.
`java.lang.Long`	`readInputInteger(java.lang.String parameterName)` Returns the value of the specified INTEGER input parameter or `null` if no value is set or the parameter does not exist.
`<T extends java.io.Serializable> java.util.List<T>`	`readInputList(java.lang.String parameterName)` Returns the list of the specified USERDEFINED input parameter or `null` if no value is set.
`java.lang.String`	`readInputString(java.lang.String parameterName)` Returns the value of the specified STRING input parameter or `null` if no value is set or the parameter does not exist.
`UDTValue`	`readInputUDT(java.lang.String parameterName)` Returns the value of the specified USERDEFINED input parameter or `null` if no value is set or the parameter does not exist.
`java.net.URI`	`readInputURI(java.lang.String parameterName)` Returns the value of the specified URI input parameter or `null` if no value is set or the parameter does not exist.
`java.lang.Boolean`	`readOutputBoolean(java.lang.String parameterName)` Returns the value stored for the specified BOOLEAN output parameter or `null` if no value is set or the parameter does not exist.
`java.util.Date`	`readOutputDate(java.lang.String parameterName)` Returns the value stored for the specified DATE output parameter or `null` if no value is set or the parameter does not exist.
`java.lang.Double`	`readOutputFloat(java.lang.String parameterName)` Returns the value stored for the specified FLOAT output parameter or `null` if no value is set or the parameter does not exist.
`java.lang.Long`	`readOutputInteger(java.lang.String parameterName)` Returns the value stored for the specified INTEGER output parameter or `null` if no value is set or the parameter does not exist.
`java.lang.String`	`readOutputString(java.lang.String parameterName)` Returns the value stored for the specified STRING output parameter or `null` if no value is set or the parameter does not exist.
`UDTValue`	`readOutputUDT(java.lang.String parameterName)` Returns the value stored for the specified USERDEFINED output parameter or `null` if no value is set or the parameter does not exist.
`java.net.URI`	`readOutputURI(java.lang.String parameterName)` Returns the value stored for the specified URI output parameter or `null` if no value is set or the parameter does not exist.
`boolean`	`requireConfBoolean(java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`java.util.Date`	`requireConfDate(java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`double`	`requireConfFloat(java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`long`	`requireConfInteger(java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`java.lang.String`	`requireConfString(java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`byte[]`	`requireConfUDT(java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`java.net.URI`	`requireConfURI(java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`boolean`	`requireInputBoolean(java.lang.String parameterName)` Returns the value of the specified BOOLEAN input parameter or throws an exception if the value is not available.
`java.util.Date`	`requireInputDate(java.lang.String parameterName)` Returns the value of the specified DATE input parameter or throws an exception if the value is not available.
`double`	`requireInputFloat(java.lang.String parameterName)` Returns the value of the specified FLOAT input parameter or throws an exception if the value is not available.
`long`	`requireInputInteger(java.lang.String parameterName)` Returns the value of the specified INTEGER input parameter or throws an exception if the value is not available.
`ProcessModelParameter`	`requireInputParam(java.lang.String parameterName)` Returns the input parameter with the given name, or throws an exception if the parameter does not exist.
`java.lang.String`	`requireInputString(java.lang.String parameterName)` Returns the value of the specified STRING input parameter or throws an exception if the value is not available.
`UDTValue`	`requireInputUDT(java.lang.String parameterName)` Returns the value of the specified USERDEFINED input parameter or throws an exception if the value is not available.
`java.net.URI`	`requireInputURI(java.lang.String parameterName)` Returns the value of the specified URI input parameter or throws an exception if the value is not available.
`ProcessModelParameter`	`requireOutputParam(java.lang.String parameterName)` Returns the output parameter with the given name, or throws an exception if the parameter does not exist.
`boolean`	`requireParamConfBoolean(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`java.util.Date`	`requireParamConfDate(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`double`	`requireParamConfFloat(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`long`	`requireParamConfInteger(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`java.lang.String`	`requireParamConfString(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`byte[]`	`requireParamConfUDT(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`java.net.URI`	`requireParamConfURI(ActivityConstants.AccessType accessType, java.lang.String parameterName, java.lang.String entryName)` Returns the configuration value of the specified entry or throws an exception if it is not available.
`java.lang.Object`	`stringToNativeTypedValue(java.lang.String value, ProcessModelParameter parameter, boolean output)` Converts an instance of `String` to an instance of the corresponding native type.
`void`	`unwriteOutputValue(java.lang.String parameterName)` Removes any previously written value for the specified output parameter.
`java.lang.Object`	`uriToNativeTypedValue(java.net.URI value, ProcessModelParameter parameter, boolean output)` Converts an instance of `URI` to an instance of the corresponding native type.
`java.lang.Object`	`userdefinedToNativeTypedValue(UDTValue value, ProcessModelParameter parameter, boolean output)` Converts an instance of `UDTValue` to an instance of the corresponding native type.
`void`	`writeOutputBoolean(java.lang.String parameterName, boolean value)` Stores the value for the specified BOOLEAN output parameter.
`void`	`writeOutputDate(java.lang.String parameterName, java.util.Date value)` Stores the value for the specified DATE output parameter.
`void`	`writeOutputFloat(java.lang.String parameterName, double value)` Stores the value for the specified FLOAT output parameter.
`void`	`writeOutputInteger(java.lang.String parameterName, long value)` Stores the value for the specified INTEGER output parameter.
`void`	`writeOutputList(java.lang.String parameterName, java.util.List<?> value)` Stores the list value for the specified USERDEFINED output parameter.
`void`	`writeOutputList(java.lang.String parameterName, ListUdt value)` Stores the list value for the specified USERDEFINED output parameter.
`void`	`writeOutputObject(java.lang.String parameterName, java.io.Serializable value)` Stores the designated serialisable object for the specified USERDEFINED output parameter.
`void`	`writeOutputString(java.lang.String parameterName, java.lang.String value)` Stores the value for the specified STRING output parameter.
`void`	`writeOutputUDT(java.lang.String parameterName, byte[] value)` Stores the value for the specified USERDEFINED output parameter.
`void`	`writeOutputUDT(java.lang.String parameterName, UDTValue value)` Stores the value for the specified USERDEFINED output parameter.
`void`	`writeOutputURI(java.lang.String parameterName, java.net.URI value)` Stores the value for the specified URI output parameter.
`protected void`	`writeOutputValue(ProcessModelParameter param, boolean convert, java.lang.Object value)` Stores the value for the specified output parameter.
`void`	`writeOutputValue(java.lang.String parameterName, java.lang.Object value)` Stores the value for the specified output parameter.
`protected void`	`writeOutputValue(java.lang.String parameterName, ProcessConstants.AdeptDataType expDt, boolean convert, java.lang.Object value)` Stores the value for the specified output parameter.
`void`	`writeOutputValues(java.lang.Object returnValue, java.lang.Object[] values)` Writes the values of the output parameters and the return value into the data context.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
protected final java.util.logging.Logger logger
```
    The logger for execution environment.
  - activityInstance
```
protected final ActivityInstance activityInstance
```
    The activity (instance) which is encapsulated by the execution environment.
  - dataContext
```
protected final DataContext dataContext
```
    The data context for the execution environment.
- Constructor Detail
  - ActivityData
```
public ActivityData(ActivityInstance activityInstance,
                    DataContext dataContext,
                    java.util.logging.Logger logger)
```
    Initialise activityInstance, dataContext and logger.
    
    Parameters:
    
    activityInstance - The activity (instance) which is encapsulated by the execution environment.
    
    dataContext - The data context for the execution environment.
    
    logger - The logger for the execution environment.
- Method Detail
  - getCorrespondingJavaClass
```
public java.lang.Class<?> getCorrespondingJavaClass(Parameter parameter,
                                                    boolean output)
```
    Gets the class object corresponding to the type of the designated parameter. This method should be overridden to return a correctly typed value.
    This implementation returns boolean, long, double, String, Object or URI).
    
    Parameters:
    
    parameter - The parameter for which the corresponding java class is to be retrieved.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    The class object corresponding to the type of the designated parameter or null in case there is no such data type.
  - getInputParams
```
public java.util.Collection<ProcessModelParameter> getInputParams()
```
    Returns all input parameters in a list.
    
    Returns:
    
    all input parameters in a list
  - getInputParam
```
public ProcessModelParameter getInputParam(java.lang.String parameterName)
```
    Returns the input parameter with the given name or null if no such parameter exists.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the input parameter or null
  - requireInputParam
```
public ProcessModelParameter requireInputParam(java.lang.String parameterName)
```
    Returns the input parameter with the given name, or throws an exception if the parameter does not exist.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the input parameter
    
    Throws:
    
    ApplicationEnvironmentException - if the parameter does not exist
  - hasParam
```
public boolean hasParam(java.lang.String parameterName,
                        ActivityConstants.AccessType accessType)
```
    Returns whether the parameter with the specified name and access type exists.
    
    Parameters:
    
    parameterName - The name of the parameter.
    
    accessType - The access type of the parameter.
    
    Returns:
    
    Whether the parameter exists.
  - hasInputParam
```
public boolean hasInputParam(java.lang.String parameterName)
```
    Returns whether the input parameter with the specified name exists.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    whether the input parameter exists
  - hasInputListParam
```
public boolean hasInputListParam(java.lang.String parameterName,
                                 ProcessConstants.AdeptDataType elementDataType)
```
    Returns whether the input parameter with the specified name exists and is a list with the specified element type.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    elementDataType - the expected element type of the list; null if this does not matter
    
    Returns:
    
    whether the input list parameter exists
  - getInputTypes
```
public java.lang.Class<?>[] getInputTypes()
```
    Gets the input parameter types in an array of the corresponding classes ordered by their position. The parameter in the first position is in the array at index 0.
    
    Returns:
    
    An array of class instances representing the input parameter types of the activity of this execution environment ordered by their position. At index 0 is the parameter with position 1.
  - hasInputValue
```
public boolean hasInputValue(java.lang.String paramName)
```
    Checks whether the value of the specified input parameter is set, i.e. is not null.
    
    Parameters:
    
    paramName - The identifier of the parameter
    
    Returns:
    
    Whether the input parameter has a value, false if the parameter is null.
  - getInputValue
```
public java.lang.Object getInputValue(java.lang.String parameterName)
                               throws ApplicationEnvironmentException
```
    Retrieves the value of the specified input parameter as an object of the closest related java type. The conversion methods are used for this.
    
    Parameters:
    
    parameterName - The identifier of the parameter
    
    Returns:
    
    The parameter value, or null if the parameter is not set.
    
    Throws:
    
    ApplicationEnvironmentException - If the parameter does not exist, the data type is invalid or no value is provided an ApplicationEnvironmentException will be thrown.
    
    See Also:
    
    booleanToNativeTypedValue(Boolean, ProcessModelParameter, boolean), integerToNativeTypedValue(Long, ProcessModelParameter, boolean), floatToNativeTypedValue(Double, ProcessModelParameter, boolean), stringToNativeTypedValue(String, ProcessModelParameter, boolean), userdefinedToNativeTypedValue(UDTValue, ProcessModelParameter, boolean), uriToNativeTypedValue(URI, ProcessModelParameter, boolean)
  - getInputValue
```
public java.lang.Object getInputValue(java.lang.String parameterName,
                                      boolean required)
                               throws ApplicationEnvironmentException
```
    Retrieves the value of the specified input parameter as an object of the closest related java type. The conversion methods are used for this.
    
    Parameters:
    
    parameterName - The identifier of the parameter
    
    required - Whether the input parameter is required (mandatory) and therefore an ApplicationEnvironmentException is to be thrown in case it is null.
    
    Returns:
    
    The parameter value, or null if the parameter is not set.
    
    Throws:
    
    ApplicationEnvironmentException - If the parameter does not exist, the data type is invalid or no value is provided an ApplicationEnvironmentException will be thrown.
    
    See Also:
    
    booleanToNativeTypedValue(Boolean, ProcessModelParameter, boolean), integerToNativeTypedValue(Long, ProcessModelParameter, boolean), floatToNativeTypedValue(Double, ProcessModelParameter, boolean), stringToNativeTypedValue(String, ProcessModelParameter, boolean), userdefinedToNativeTypedValue(UDTValue, ProcessModelParameter, boolean), uriToNativeTypedValue(URI, ProcessModelParameter, boolean)
  - getInputValue
```
protected java.lang.Object getInputValue(java.lang.String parameterName,
                                         ProcessConstants.AdeptDataType expDt,
                                         boolean convert,
                                         boolean required)
                                  throws ApplicationEnvironmentException
```
    Retrieves the value of the specified input parameter as an object of the closest related java type. The conversion methods are used if requested. The designated expected data type improves the type safety. If it does not match the type of the parameter, an ApplicationEnvironmentException will be thrown.
    
    Parameters:
    
    parameterName - The name of the parameter for which to retrieve the value.
    
    expDt - The data type which is expected. If this is null, the data type of the parameter will not be checked.
    
    convert - Whether to convert the retrieved values with the appropriate methods.
    
    required - Whether the input parameter is required (mandatory) and therefore an ApplicationEnvironmentException is to be thrown in case it is null.
    
    Returns:
    
    The parameter value, or null if the parameter is not set.
    
    Throws:
    
    ApplicationEnvironmentException - If the parameter does not exist, the data type is invalid or no value is provided for a required parameter an ApplicationEnvironmentException will be thrown.
    
    See Also:
    
    booleanToNativeTypedValue(Boolean, ProcessModelParameter, boolean), integerToNativeTypedValue(Long, ProcessModelParameter, boolean), floatToNativeTypedValue(Double, ProcessModelParameter, boolean), stringToNativeTypedValue(String, ProcessModelParameter, boolean), userdefinedToNativeTypedValue(UDTValue, ProcessModelParameter, boolean), uriToNativeTypedValue(URI, ProcessModelParameter, boolean)
  - getInputValue
```
public java.lang.Object getInputValue(ProcessModelParameter param,
                                      boolean convert,
                                      boolean required)
                               throws ApplicationEnvironmentException
```
    Retrieves the value of the specified input parameter as an object of the closest related java type or the appropriate converted type.
    
    Parameters:
    
    param - The parameter for which to retrieve the value.
    
    convert - Whether to convert the retrieved values with the appropriate methods.
    
    required - Whether the input parameter is required (mandatory) and therefore an ApplicationEnvironmentException is to be thrown in case it is null.
    
    Returns:
    
    The parameter value, or null if the parameter is not set.
    
    Throws:
    
    ApplicationEnvironmentException - If the parameter does not exist, the data type is invalid or no value is provided for a required parameter an ApplicationEnvironmentException will be thrown.
    
    See Also:
    
    booleanToNativeTypedValue(Boolean, ProcessModelParameter, boolean), integerToNativeTypedValue(Long, ProcessModelParameter, boolean), floatToNativeTypedValue(Double, ProcessModelParameter, boolean), stringToNativeTypedValue(String, ProcessModelParameter, boolean), userdefinedToNativeTypedValue(UDTValue, ProcessModelParameter, boolean), uriToNativeTypedValue(URI, ProcessModelParameter, boolean)
  - getInputValues
```
public java.lang.Object[] getInputValues()
```
    Gets the values of the input parameter in an array of object ordered by their position. The parameter in the first position is in the array at index 0. Exceptions lead to ApplicationEnvironmentExceptions.
    
    Returns:
    
    An array of object instances representing the input parameters values of the activity of this execution environment ordered by their position. At index 0 is the parameter with position 1.
    
    Throws:
    
    ApplicationEnvironmentException - If a parameter does not exist, the data type is invalid or no value is provided for a required parameter an ApplicationEnvironmentException will be thrown.
    
    See Also:
    
    getInputValue(String)
  - getDualInputValue
```
public <T> T getDualInputValue(java.lang.String name,
                               ProcessConstants.AdeptDataType type,
                               java.lang.Class<T> valueType)
```
    A "dual input parameter" is a parameter whose value can either be provided by an input parameter or by an activity configuration field with the same name or a combination of both. For this method the data type of the parameter is expected to be the given type and the value of the activity parameter configuration field must be a valid string representation of that data type. In case of ProcessConstants.AdeptDataType.DATE and ProcessConstants.AdeptDataType.USERDEFINED the special access method of the configuration will be used. It's basically an input parameter with a default value provided in the ATC.
    The following are the possible constellations:
    - if the parameter is present and not optional, the ATC field is ignored
    - if the parameter is present but optional, the value of the ATC field is only returned if the data element of the input parameter has not been written yet
    - if the parameter is not present, the value of the ATC field is always returned
    Type Parameters:
    
    T - The type which the requested value is expected to be of.
    
    Parameters:
    
    name - The name of the dual input parameter (i.e. input parameter + ATC field).
    
    type - The data type of the parameter or configuration entry.
    
    valueType - The (object) type of which the requested value is expected to be.
    
    Returns:
    
    The value of the dual parameter.
  - readInputBoolean
```
public java.lang.Boolean readInputBoolean(java.lang.String parameterName)
```
    Returns the value of the specified BOOLEAN input parameter or null if no value is set or the parameter does not exist. Use this method for optional input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value; may be null
    
    See Also:
    
    requireInputBoolean(String), InputDataContext.retrieveBooleanParameterValue(String)
  - readInputInteger
```
public java.lang.Long readInputInteger(java.lang.String parameterName)
```
    Returns the value of the specified INTEGER input parameter or null if no value is set or the parameter does not exist. Use this method for optional input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value; may be null
    
    See Also:
    
    requireInputInteger(String), InputDataContext.retrieveIntegerParameterValue(String)
  - readInputFloat
```
public java.lang.Double readInputFloat(java.lang.String parameterName)
```
    Returns the value of the specified FLOAT input parameter or null if no value is set or the parameter does not exist. Use this method for optional input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value; may be null
    
    See Also:
    
    requireInputFloat(String), InputDataContext.retrieveFloatParameterValue(String)
  - readInputString
```
public java.lang.String readInputString(java.lang.String parameterName)
```
    Returns the value of the specified STRING input parameter or null if no value is set or the parameter does not exist. Use this method for optional input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value; may be null
    
    See Also:
    
    requireInputString(String), InputDataContext.retrieveStringParameterValue(String)
  - readInputDate
```
public java.util.Date readInputDate(java.lang.String parameterName)
```
    Returns the value of the specified DATE input parameter or null if no value is set or the parameter does not exist. Use this method for optional input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value; may be null
    
    See Also:
    
    requireInputDate(String), InputDataContext.retrieveDateParameterValue(String)
  - readInputURI
```
public java.net.URI readInputURI(java.lang.String parameterName)
```
    Returns the value of the specified URI input parameter or null if no value is set or the parameter does not exist. Use this method for optional input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value; may be null
    
    See Also:
    
    requireInputURI(String), InputDataContext.retrieveURIParameterValue(String)
  - readInputUDT
```
public UDTValue readInputUDT(java.lang.String parameterName)
```
    Returns the value of the specified USERDEFINED input parameter or null if no value is set or the parameter does not exist. Use this method for optional input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value; may be null
    
    See Also:
    
    requireInputUDT(String), InputDataContext.retrieveUDTParameterValue(String)
  - readInputList
```
public <T extends java.io.Serializable> java.util.List<T> readInputList(java.lang.String parameterName)
```
    Returns the list of the specified USERDEFINED input parameter or null if no value is set. Use this method for optional input parameters.
    
    Type Parameters:
    
    T - the element type of the list
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved list; may be null
    
    See Also:
    
    requireInputList(String)
  - requireInputBoolean
```
public boolean requireInputBoolean(java.lang.String parameterName)
                            throws ApplicationEnvironmentException
```
    Returns the value of the specified BOOLEAN input parameter or throws an exception if the value is not available. Use this method for mandatory input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value
    
    Throws:
    
    ApplicationEnvironmentException - if the input value could not be retrieved (parameter does not exist; wrong data type) or if the value is not available
    
    See Also:
    
    readInputBoolean(String), InputDataContext.retrieveBooleanParameterValue(String)
  - requireInputInteger
```
public long requireInputInteger(java.lang.String parameterName)
                         throws ApplicationEnvironmentException
```
    Returns the value of the specified INTEGER input parameter or throws an exception if the value is not available. Use this method for mandatory input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value
    
    Throws:
    
    ApplicationEnvironmentException - if the input value could not be retrieved (parameter does not exist; wrong data type) or if the value is not available
    
    See Also:
    
    readInputInteger(String), InputDataContext.retrieveIntegerParameterValue(String)
  - requireInputFloat
```
public double requireInputFloat(java.lang.String parameterName)
                         throws ApplicationEnvironmentException
```
    Returns the value of the specified FLOAT input parameter or throws an exception if the value is not available. Use this method for mandatory input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value
    
    Throws:
    
    ApplicationEnvironmentException - if the input value could not be retrieved (parameter does not exist; wrong data type) or if the value is not available
    
    See Also:
    
    readInputFloat(String), InputDataContext.retrieveFloatParameterValue(String)
  - requireInputString
```
public java.lang.String requireInputString(java.lang.String parameterName)
                                    throws ApplicationEnvironmentException
```
    Returns the value of the specified STRING input parameter or throws an exception if the value is not available. Use this method for mandatory input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value; never null
    
    Throws:
    
    ApplicationEnvironmentException - if the input value could not be retrieved (parameter does not exist; wrong data type) or if the value is not available
    
    See Also:
    
    readInputString(String), InputDataContext.retrieveStringParameterValue(String)
  - requireInputDate
```
public java.util.Date requireInputDate(java.lang.String parameterName)
                                throws ApplicationEnvironmentException
```
    Returns the value of the specified DATE input parameter or throws an exception if the value is not available. Use this method for mandatory input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value; never null
    
    Throws:
    
    ApplicationEnvironmentException - if the input value could not be retrieved (parameter does not exist; wrong data type) or if the value is not available
    
    See Also:
    
    readInputDate(String), InputDataContext.retrieveDateParameterValue(String)
  - requireInputURI
```
public java.net.URI requireInputURI(java.lang.String parameterName)
                             throws ApplicationEnvironmentException
```
    Returns the value of the specified URI input parameter or throws an exception if the value is not available. Use this method for mandatory input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value; never null
    
    Throws:
    
    ApplicationEnvironmentException - if the input value could not be retrieved (parameter does not exist; wrong data type) or if the value is not available
    
    See Also:
    
    readInputURI(String), InputDataContext.retrieveURIParameterValue(String)
  - requireInputUDT
```
public UDTValue requireInputUDT(java.lang.String parameterName)
                         throws ApplicationEnvironmentException
```
    Returns the value of the specified USERDEFINED input parameter or throws an exception if the value is not available. Use this method for mandatory input parameters.
    
    Parameters:
    
    parameterName - name of the input parameter
    
    Returns:
    
    the retrieved value; never null
    
    Throws:
    
    ApplicationEnvironmentException - if the input value could not be retrieved (parameter does not exist; wrong data type) or if the value is not available
    
    See Also:
    
    readInputUDT(String), InputDataContext.retrieveUDTParameterValue(String)
  - booleanToNativeTypedValue
```
public java.lang.Object booleanToNativeTypedValue(java.lang.Boolean value,
                                                  ProcessModelParameter parameter,
                                                  boolean output)
```
    Converts an instance of Boolean to an instance of the corresponding native type. This method should be overridden to return a correctly typed value.
    This implementation returns the instance unchanged.
    
    Parameters:
    
    value - An instance of Boolean to be converted to native type.
    
    parameter - The corresponding parameter for further information.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    The designated value unchanged.
  - integerToNativeTypedValue
```
public java.lang.Object integerToNativeTypedValue(java.lang.Long value,
                                                  ProcessModelParameter parameter,
                                                  boolean output)
```
    Converts an instance of Long to an instance of the corresponding native type. This method should be overridden to return a correctly typed value.
    This implementation returns the instance unchanged.
    
    Parameters:
    
    value - An instance of Long to be converted to native type.
    
    parameter - The corresponding parameter for further information.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    The designated value unchanged.
  - floatToNativeTypedValue
```
public java.lang.Object floatToNativeTypedValue(java.lang.Double value,
                                                ProcessModelParameter parameter,
                                                boolean output)
```
    Converts an instance of Double to an instance of the corresponding native type. This method should be overridden to return a correctly typed value.
    This implementation returns the instance unchanged.
    
    Parameters:
    
    value - An instance of Double to be converted to native type.
    
    parameter - The corresponding parameter for further information.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    The designated value unchanged.
  - stringToNativeTypedValue
```
public java.lang.Object stringToNativeTypedValue(java.lang.String value,
                                                 ProcessModelParameter parameter,
                                                 boolean output)
```
    Converts an instance of String to an instance of the corresponding native type. This method should be overridden to return a correctly typed value.
    This implementation returns the instance unchanged.
    
    Parameters:
    
    value - An instance of String to be converted to native type.
    
    parameter - The corresponding parameter for further information.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    The designated value unchanged.
  - dateToNativeTypedValue
```
public java.lang.Object dateToNativeTypedValue(java.util.Date value,
                                               ProcessModelParameter parameter,
                                               boolean output)
```
    Converts an instance of Date to an instance of the corresponding native type. This method should be overridden to return a correctly typed value.
    This implementation returns the instance unchanged.
    
    Parameters:
    
    value - An instance of Date to be converted to native type.
    
    parameter - The corresponding parameter for further information.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    The designated value unchanged.
  - userdefinedToNativeTypedValue
```
public java.lang.Object userdefinedToNativeTypedValue(UDTValue value,
                                                      ProcessModelParameter parameter,
                                                      boolean output)
```
    Converts an instance of UDTValue to an instance of the corresponding native type. This method should be overridden to return a correctly typed value.
    This implementation creates an instance of Object by interpreting the UDT as an object stream and de-serialising the appropriate object. In case of a ListUdt it will be unmarshalled appropriately and the corresponding list will be returned.
    The corresponding class of the object needs to be in the class path!
    
    Parameters:
    
    value - The UDTValue containing a serialised object to be converted to native type.
    
    parameter - The corresponding parameter for further information.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    An instance of Object read from the designated UDTValue or null in case the object can not be read.
  - uriToNativeTypedValue
```
public java.lang.Object uriToNativeTypedValue(java.net.URI value,
                                              ProcessModelParameter parameter,
                                              boolean output)
```
    Converts an instance of URI to an instance of the corresponding native type. This method should be overridden to return a correctly typed value.
    This implementation returns the instance unchanged.
    
    Parameters:
    
    value - An instance of URI to be converted to native type.
    
    parameter - The corresponding parameter for further information.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    The designated value unchanged.
  - getStoredValue
```
public java.lang.Object getStoredValue(java.lang.String parameterName)
                                throws ApplicationEnvironmentException
```
    Retrieves the stored value of the specified output parameter as an object of the closest related java type. The conversion methods are used for this.
    
    Parameters:
    
    parameterName - The identifier of the parameter
    
    Returns:
    
    The parameter value, or null if the parameter has not been written yet.
    
    Throws:
    
    ApplicationEnvironmentException - If the parameter does not exist or the data type is invalid an ApplicationEnvironmentException will be thrown.
    
    See Also:
    
    booleanToNativeTypedValue(Boolean, ProcessModelParameter, boolean), integerToNativeTypedValue(Long, ProcessModelParameter, boolean), floatToNativeTypedValue(Double, ProcessModelParameter, boolean), stringToNativeTypedValue(String, ProcessModelParameter, boolean), userdefinedToNativeTypedValue(UDTValue, ProcessModelParameter, boolean), uriToNativeTypedValue(URI, ProcessModelParameter, boolean), getInputValue(String)
  - getStoredValue
```
protected java.lang.Object getStoredValue(java.lang.String parameterName,
                                          ProcessConstants.AdeptDataType expDt,
                                          boolean convert)
                                   throws ApplicationEnvironmentException
```
    Retrieves the stored value of the specified output parameter as an object of the closest related java type. The conversion methods are used if requested. The designated expected data type improves the type safety. If it does not match the type of the parameter, an ApplicationEnvironmentException will be thrown.
    
    Parameters:
    
    parameterName - The name of the parameter for which to retrieve the value.
    
    expDt - The data type which is expected. If this is null, the data type of the parameter will not be checked.
    
    convert - Whether to convert the retrieved values with the appropriate methods.
    
    Returns:
    
    The parameter value, or null if the parameter is not set.
    
    Throws:
    
    ApplicationEnvironmentException - If the parameter does not exist or the data type is invalid an ApplicationEnvironmentException will be thrown.
    
    See Also:
    
    booleanToNativeTypedValue(Boolean, ProcessModelParameter, boolean), integerToNativeTypedValue(Long, ProcessModelParameter, boolean), floatToNativeTypedValue(Double, ProcessModelParameter, boolean), stringToNativeTypedValue(String, ProcessModelParameter, boolean), userdefinedToNativeTypedValue(UDTValue, ProcessModelParameter, boolean), uriToNativeTypedValue(URI, ProcessModelParameter, boolean)
  - getStoredValue
```
public java.lang.Object getStoredValue(ProcessModelParameter param,
                                       boolean convert)
                                throws ApplicationEnvironmentException
```
    Retrieves the stored value of the specified output parameter as an object of the closest related java type or the appropriate converted type.
    
    Parameters:
    
    param - The parameter for which to retrieve the value.
    
    convert - Whether to convert the retrieved values with the appropriate methods.
    
    Returns:
    
    The parameter value, or null if the parameter is not set.
    
    Throws:
    
    ApplicationEnvironmentException - If the parameter does not exist or the data type is invalid an ApplicationEnvironmentException will be thrown.
    
    See Also:
    
    booleanToNativeTypedValue(Boolean, ProcessModelParameter, boolean), integerToNativeTypedValue(Long, ProcessModelParameter, boolean), floatToNativeTypedValue(Double, ProcessModelParameter, boolean), stringToNativeTypedValue(String, ProcessModelParameter, boolean), userdefinedToNativeTypedValue(UDTValue, ProcessModelParameter, boolean), uriToNativeTypedValue(URI, ProcessModelParameter, boolean)
  - getStoredValues
```
public java.lang.Object[] getStoredValues()
                                   throws ApplicationEnvironmentException
```
    Gets the stored values of the output parameter in an array of object ordered by their position. The parameter in the first position is in the array at index 0. Exceptions when reading a value of user-defined data type, incorrect parameter names and incorrect parameter types are logged and the corresponding parameter value is set to null.
    
    Returns:
    
    An array of object instances representing the output parameters values of the activity of this execution environment ordered by their position. At index 0 is the parameter with position 1.
    
    Throws:
    
    ApplicationEnvironmentException - If the parameter does not exist or the data type is invalid an ApplicationEnvironmentException will be thrown.
    
    See Also:
    
    getStoredValue(String)
  - readOutputBoolean
```
public java.lang.Boolean readOutputBoolean(java.lang.String parameterName)
```
    Returns the value stored for the specified BOOLEAN output parameter or null if no value is set or the parameter does not exist.
    
    Parameters:
    
    parameterName - The name of the output parameter.
    
    Returns:
    
    The previously stored value; may be null.
    
    See Also:
    
    writeOutputBoolean(String, boolean), DataContext.storedBooleanParameterValue(String)
  - readOutputInteger
```
public java.lang.Long readOutputInteger(java.lang.String parameterName)
```
    Returns the value stored for the specified INTEGER output parameter or null if no value is set or the parameter does not exist.
    
    Parameters:
    
    parameterName - The name of the output parameter.
    
    Returns:
    
    The previously stored value; may be null.
    
    See Also:
    
    writeOutputInteger(String, long), DataContext.storedIntegerParameterValue(String)
  - readOutputFloat
```
public java.lang.Double readOutputFloat(java.lang.String parameterName)
```
    Returns the value stored for the specified FLOAT output parameter or null if no value is set or the parameter does not exist.
    
    Parameters:
    
    parameterName - The name of the output parameter.
    
    Returns:
    
    The previously stored value; may be null.
    
    See Also:
    
    writeOutputFloat(String, double), DataContext.storedFloatParameterValue(String)
  - readOutputString
```
public java.lang.String readOutputString(java.lang.String parameterName)
```
    Returns the value stored for the specified STRING output parameter or null if no value is set or the parameter does not exist.
    
    Parameters:
    
    parameterName - The name of the output parameter.
    
    Returns:
    
    The previously stored value; may be null.
    
    See Also:
    
    writeOutputString(String, String), DataContext.storedStringParameterValue(String)
  - readOutputDate
```
public java.util.Date readOutputDate(java.lang.String parameterName)
```
    Returns the value stored for the specified DATE output parameter or null if no value is set or the parameter does not exist.
    
    Parameters:
    
    parameterName - The name of the output parameter.
    
    Returns:
    
    The previously stored value; may be null.
    
    See Also:
    
    writeOutputDate(String, Date), DataContext.storedDateParameterValue(String)
  - readOutputURI
```
public java.net.URI readOutputURI(java.lang.String parameterName)
```
    Returns the value stored for the specified URI output parameter or null if no value is set or the parameter does not exist.
    
    Parameters:
    
    parameterName - The name of the output parameter.
    
    Returns:
    
    The previously stored value; may be null.
    
    See Also:
    
    writeOutputURI(String, URI), DataContext.storedURIParameterValue(String)
  - readOutputUDT
```
public UDTValue readOutputUDT(java.lang.String parameterName)
```
    Returns the value stored for the specified USERDEFINED output parameter or null if no value is set or the parameter does not exist.
    
    Parameters:
    
    parameterName - The name of the output parameter.
    
    Returns:
    
    The previously stored value; may be null.
    
    See Also:
    
    writeOutputUDT(String, UDTValue), writeOutputUDT(String, byte[]), DataContext.storedUDTParameterValue(String)
  - getOutputParams
```
public java.util.Collection<ProcessModelParameter> getOutputParams()
```
    Returns all output parameters in a list.
    
    Returns:
    
    all output parameters in a list
  - getOutputParam
```
public ProcessModelParameter getOutputParam(java.lang.String parameterName)
```
    Returns the output parameter with the given name or null if no such parameter exists.
    
    Parameters:
    
    parameterName - name of the output parameter
    
    Returns:
    
    the input parameter or null
  - requireOutputParam
```
public ProcessModelParameter requireOutputParam(java.lang.String parameterName)
```
    Returns the output parameter with the given name, or throws an exception if the parameter does not exist.
    
    Parameters:
    
    parameterName - name of the output parameter
    
    Returns:
    
    the input parameter
    
    Throws:
    
    ApplicationEnvironmentException - if the parameter does not exist
  - hasOutputParam
```
public boolean hasOutputParam(java.lang.String parameterName)
```
    Returns whether the output parameter with the specified name exists.
    
    Parameters:
    
    parameterName - the output parameter name
    
    Returns:
    
    whether the output parameter exists
  - writeOutputValue
```
public void writeOutputValue(java.lang.String parameterName,
                             java.lang.Object value)
```
    Stores the value for the specified output parameter. This will overwrite any previously written value.
    The conversion methods are used for this. Per default they expect the object types to be the same as the matching type-specific setOutput methods. If the value is a List it will be serialised accordingly to a UDT value.
    
    Parameters:
    
    parameterName - The name of the output parameter.
    
    value - The value to be stored.
    
    See Also:
    
    objectToBoolean(Object, ProcessModelParameter, boolean), objectToInteger(Object, ProcessModelParameter, boolean), objectToFloat(Object, ProcessModelParameter, boolean), objectToString(Object, ProcessModelParameter, boolean), objectToUserdefined(Object, ProcessModelParameter, boolean), objectToUri(Object, ProcessModelParameter, boolean)
  - writeOutputValue
```
protected void writeOutputValue(java.lang.String parameterName,
                                ProcessConstants.AdeptDataType expDt,
                                boolean convert,
                                java.lang.Object value)
```
    Stores the value for the specified output parameter. This will overwrite any previously written value. The designated expected data type improves the type safety. If it does not match the type of the parameter, an ApplicationEnvironmentException will be thrown.
    The conversion methods are used for this. Per default they expect the object types to be the same as the matching type-specific setOutput methods. If the value is a List it will be serialised accordingly to a UDT value.
    
    Parameters:
    
    parameterName - The name of the output parameter.
    
    expDt - The data type which is expected. If this is null, the data type of the parameter will not be checked.
    
    convert - Whether to convert the designated value with the appropriate methods before storing it.
    
    value - The value to be stored.
    
    See Also:
    
    objectToBoolean(Object, ProcessModelParameter, boolean), objectToInteger(Object, ProcessModelParameter, boolean), objectToFloat(Object, ProcessModelParameter, boolean), objectToString(Object, ProcessModelParameter, boolean), objectToUserdefined(Object, ProcessModelParameter, boolean), objectToUri(Object, ProcessModelParameter, boolean), uriToNativeTypedValue(URI, ProcessModelParameter, boolean)
  - writeOutputValue
```
protected void writeOutputValue(ProcessModelParameter param,
                                boolean convert,
                                java.lang.Object value)
```
    Stores the value for the specified output parameter. This will overwrite any previously written value.
    
    Parameters:
    
    param - The output parameter.
    
    convert - Whether to convert the designated value with the appropriate methods before storing it.
    
    value - The value to be stored.
    
    See Also:
    
    objectToBoolean(Object, ProcessModelParameter, boolean), objectToInteger(Object, ProcessModelParameter, boolean), objectToFloat(Object, ProcessModelParameter, boolean), objectToString(Object, ProcessModelParameter, boolean), objectToUserdefined(Object, ProcessModelParameter, boolean), objectToUri(Object, ProcessModelParameter, boolean)
  - writeOutputValues
```
public void writeOutputValues(java.lang.Object returnValue,
                              java.lang.Object[] values)
```
    Writes the values of the output parameters and the return value into the data context. The designated return value is stored as value for the parameter with position 0. Exceptions when accessing the values (invalid positions or no values provided) are logged and the corresponding value is set to NULL.
    
    Parameters:
    
    returnValue - The return value of the application which is stored for the output parameter with position 0.
    
    values - The output parameter values as array of object. The positions need to correspond to the parameter positions defined for the executed activity while the parameter with position 1 is stored at index 0 in the array.
  - unwriteOutputValue
```
public void unwriteOutputValue(java.lang.String parameterName)
```
    Removes any previously written value for the specified output parameter.
    
    Parameters:
    
    parameterName - name of the output parameter
  - writeOutputBoolean
```
public void writeOutputBoolean(java.lang.String parameterName,
                               boolean value)
```
    Stores the value for the specified BOOLEAN output parameter. This will overwrite any previously written value.
    
    Parameters:
    
    parameterName - name of the output parameter
    
    value - the value to be stored
    
    See Also:
    
    DataContext.storeBooleanParameterValue(String, boolean)
  - writeOutputInteger
```
public void writeOutputInteger(java.lang.String parameterName,
                               long value)
```
    Stores the value for the specified INTEGER output parameter. This will overwrite any previously written value.
    
    Parameters:
    
    parameterName - name of the output parameter
    
    value - the value to be stored
    
    See Also:
    
    DataContext.storeIntegerParameterValue(String, long)
  - writeOutputFloat
```
public void writeOutputFloat(java.lang.String parameterName,
                             double value)
```
    Stores the value for the specified FLOAT output parameter. This will overwrite any previously written value.
    
    Parameters:
    
    parameterName - name of the output parameter
    
    value - the value to be stored
    
    See Also:
    
    DataContext.storeFloatParameterValue(String, double)
  - writeOutputString
```
public void writeOutputString(java.lang.String parameterName,
                              java.lang.String value)
```
    Stores the value for the specified STRING output parameter. This will overwrite any previously written value.
    
    Parameters:
    
    parameterName - name of the output parameter
    
    value - the value to be stored
    
    See Also:
    
    DataContext.storeStringParameterValue(String, String)
  - writeOutputDate
```
public void writeOutputDate(java.lang.String parameterName,
                            java.util.Date value)
```
    Stores the value for the specified DATE output parameter. This will overwrite any previously written value.
    
    Parameters:
    
    parameterName - name of the output parameter
    
    value - the value to be stored
    
    See Also:
    
    DataContext.storeDateParameterValue(String, Date)
  - writeOutputURI
```
public void writeOutputURI(java.lang.String parameterName,
                           java.net.URI value)
```
    Stores the value for the specified URI output parameter. This will overwrite any previously written value.
    
    Parameters:
    
    parameterName - name of the output parameter
    
    value - the value to be stored
    
    See Also:
    
    DataContext.storeURIParameterValue(String, URI)
  - writeOutputUDT
```
public void writeOutputUDT(java.lang.String parameterName,
                           UDTValue value)
```
    Stores the value for the specified USERDEFINED output parameter. This will overwrite any previously written value.
    
    Parameters:
    
    parameterName - name of the output parameter
    
    value - the value to be stored
    
    See Also:
    
    DataContext.storeUDTParameterValue(String, UDTValue)
  - writeOutputUDT
```
public void writeOutputUDT(java.lang.String parameterName,
                           byte[] value)
```
    Stores the value for the specified USERDEFINED output parameter. The same user-defined type will be assumed as the output parameter. This will overwrite any previously written value.
    
    Parameters:
    
    parameterName - name of the output parameter
    
    value - the value to be stored
    
    See Also:
    
    DataContext.storeUDTParameterValue(String, UDTValue)
  - writeOutputList
```
public void writeOutputList(java.lang.String parameterName,
                            java.util.List<?> value)
```
    Stores the list value for the specified USERDEFINED output parameter. This will overwrite any previously written value.
    
    Parameters:
    
    parameterName - name of the output parameter
    
    value - the list to be stored
    
    See Also:
    
    DataContext.storeUDTParameterValue(String, UDTValue)
  - writeOutputList
```
public void writeOutputList(java.lang.String parameterName,
                            ListUdt value)
```
    Stores the list value for the specified USERDEFINED output parameter. This will overwrite any previously written value.
    
    Parameters:
    
    parameterName - name of the output parameter
    
    value - the ListUdt to be stored
    
    See Also:
    
    DataContext.storeUDTParameterValue(String, UDTValue)
  - writeOutputObject
```
public void writeOutputObject(java.lang.String parameterName,
                              java.io.Serializable value)
```
    Stores the designated serialisable object for the specified USERDEFINED output parameter. This will overwrite any previously written value.
    
    Parameters:
    
    parameterName - name of the output parameter
    
    value - The serialisable object to store.
    
    See Also:
    
    DataContext.storeUDTParameterValue(String, UDTValue)
  - objectToBoolean
```
public java.lang.Boolean objectToBoolean(java.lang.Object value,
                                         ProcessModelParameter parameter,
                                         boolean output)
```
    Converts an object (of native type) to an instance of Boolean. This method should be overridden to convert from the correct native type.
    This implementation casts the designated parameter.
    
    Parameters:
    
    value - An instance of Object (native data type) to be converted to Boolean. This may be null.
    
    parameter - The corresponding parameter for further information.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    The designated value cast.
  - objectToInteger
```
public java.lang.Long objectToInteger(java.lang.Object value,
                                      ProcessModelParameter parameter,
                                      boolean output)
```
    Converts an object (of native type) to an instance of Long. This method should be overridden to convert from the correct native type.
    This implementation casts the designated parameter.
    
    Parameters:
    
    value - An instance of Object (native data type) to be converted to Long. This may be null.
    
    parameter - The corresponding parameter for further information.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    The designated value cast.
  - objectToFloat
```
public java.lang.Double objectToFloat(java.lang.Object value,
                                      ProcessModelParameter parameter,
                                      boolean output)
```
    Converts an object (of native type) to an instance of Double. This method should be overridden to convert from the correct native type.
    This implementation casts the designated parameter.
    
    Parameters:
    
    value - An instance of Object (native data type) to be converted to Double. This may be null.
    
    parameter - The corresponding parameter for further information.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    The designated value cast.
  - objectToString
```
public java.lang.String objectToString(java.lang.Object value,
                                       ProcessModelParameter parameter,
                                       boolean output)
```
    Converts an object (of native type) to an instance of String. This method should be overridden to convert from the correct native type.
    This implementation casts the designated parameter.
    
    Parameters:
    
    value - An instance of Object (native data type) to be converted to String. This may be null.
    
    parameter - The corresponding parameter for further information.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    The designated value cast.
  - objectToDate
```
public java.util.Date objectToDate(java.lang.Object value,
                                   ProcessModelParameter parameter,
                                   boolean output)
```
    Converts an object (of native type) to an instance of Date. This method should be overridden to convert from the correct native type.
    This implementation casts the designated parameter.
    
    Parameters:
    
    value - An instance of Object (native data type) to be converted to Date. This may be null.
    
    parameter - The corresponding parameter for further information.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    The designated value cast.
  - objectToUserdefined
```
public UDTValue objectToUserdefined(java.lang.Object value,
                                    ProcessModelParameter parameter,
                                    boolean output)
```
    Converts an object to an instance of UDTValue by serialising the object and encapsulating the corresponding stream in the returned instance of UDTValue.
    The object needs to be serialisable! In case of a UDTValue, it will be used directly. If the object is not serialisable or serialisation fails, an ApplicationFailedException will be thrown.
    
    Parameters:
    
    value - The object to store in an instance of UDTValue. This must not be null.
    
    parameter - The output parameter that needs a conversion from Object to UDTValue.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    An instance of UDTValue encapsulating the serialised designated object.
  - objectToUri
```
public java.net.URI objectToUri(java.lang.Object value,
                                ProcessModelParameter parameter,
                                boolean output)
```
    Converts an object (of native type) to an instance of URI. This method should be overridden to convert from the correct native type.
    This implementation casts the designated parameter.
    
    Parameters:
    
    value - An instance of Object (native data type) to be converted to URI. This may be null.
    
    parameter - The corresponding parameter for further information.
    
    output - Whether the designated parameter is an output parameter (or an input parameter otherwise).
    
    Returns:
    
    The designated value cast.
  - getAllConfEntries
```
public java.util.Collection<java.lang.String> getAllConfEntries()
```
    Returns all configuration entry names.
    
    Returns:
    
    All entry names that have a value in this configuration or are retrieved from an input parameter or a process configuration.
  - hasConf
```
public boolean hasConf(java.lang.String entryName)
```
    Returns whether the specified configuration entry is set.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    whether the specified configuration entry is set
  - getConfBoolean
```
public java.lang.Boolean getConfBoolean(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or null if it is not set.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value or the given default value
  - getConfBoolean
```
public java.lang.Boolean getConfBoolean(java.lang.String entryName,
                                        java.lang.Boolean defaultValue)
```
    Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as BOOLEAN. In the latter case a warning is logged.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - getConfInteger
```
public java.lang.Long getConfInteger(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or null if it is not set.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value or the given default value
  - getConfInteger
```
public java.lang.Long getConfInteger(java.lang.String entryName,
                                     java.lang.Long defaultValue)
```
    Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as INTEGER. In the latter case a warning is logged.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - getConfFloat
```
public java.lang.Double getConfFloat(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or the given value if it is not set or could not be parsed as FLOAT. In the latter case a warning is logged.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value or the given default value
  - getConfFloat
```
public java.lang.Double getConfFloat(java.lang.String entryName,
                                     java.lang.Double defaultValue)
```
    Returns the configuration value of the specified entry or the given value if it is not set or could not be parsed as FLOAT. In the latter case a warning is logged.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - getConfString
```
public java.lang.String getConfString(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or null if it is not set.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value or the given default value
  - getConfString
```
public java.lang.String getConfString(java.lang.String entryName,
                                      java.lang.String defaultValue)
```
    Returns the configuration value of the specified entry or the given default value if it is not set.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - getConfDate
```
public java.util.Date getConfDate(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or null if it is not set.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value or the given default value
  - getConfDate
```
public java.util.Date getConfDate(java.lang.String entryName,
                                  java.util.Date defaultValue)
```
    Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as DATE. In the latter case a warning is logged.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - getConfURI
```
public java.net.URI getConfURI(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or null if it is not set.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value or the given default value
  - getConfURI
```
public java.net.URI getConfURI(java.lang.String entryName,
                               java.net.URI defaultValue)
```
    Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as URI. In the latter case a warning is logged.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - getConfUDT
```
public byte[] getConfUDT(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as USERDEFINED. In the latter case a warning is logged.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value or the given default value
  - getConfUDT
```
public byte[] getConfUDT(java.lang.String entryName,
                         byte[] defaultValue)
```
    Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as USERDEFINED. In the latter case a warning is logged.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - requireConfBoolean
```
public boolean requireConfBoolean(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing or cannot be parsed as BOOLEAN
  - requireConfInteger
```
public long requireConfInteger(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing or cannot be parsed as INTEGER
  - requireConfFloat
```
public double requireConfFloat(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing or cannot be parsed as FLOAT
  - requireConfString
```
public java.lang.String requireConfString(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value; never null
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing
  - requireConfDate
```
public java.util.Date requireConfDate(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value; never null
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing or cannot be parsed as DATE
  - requireConfURI
```
public java.net.URI requireConfURI(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value; never null
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing or cannot be parsed as URI
  - requireConfUDT
```
public byte[] requireConfUDT(java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value; never null
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing or cannot be parsed as USERDEFINED
  - hasParamConf
```
public boolean hasParamConf(ActivityConstants.AccessType accessType,
                            java.lang.String parameterName,
                            java.lang.String entryName)
```
    Returns whether the specified configuration entry is set.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    Returns:
    
    whether the specified configuration entry is set
  - getParamConfBoolean
```
public java.lang.Boolean getParamConfBoolean(ActivityConstants.AccessType accessType,
                                             java.lang.String parameterName,
                                             java.lang.String entryName,
                                             java.lang.Boolean defaultValue)
```
    Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as BOOLEAN. In the latter case a warning is logged.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - getParamConfInteger
```
public java.lang.Long getParamConfInteger(ActivityConstants.AccessType accessType,
                                          java.lang.String parameterName,
                                          java.lang.String entryName,
                                          java.lang.Long defaultValue)
```
    Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as INTEGER. In the latter case a warning is logged.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - getParamConfFloat
```
public java.lang.Double getParamConfFloat(ActivityConstants.AccessType accessType,
                                          java.lang.String parameterName,
                                          java.lang.String entryName,
                                          java.lang.Double defaultValue)
```
    Returns the configuration value of the specified entry or the given value if it is not set or could not be parsed as FLOAT. In the latter case a warning is logged.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - getParamConfString
```
public java.lang.String getParamConfString(ActivityConstants.AccessType accessType,
                                           java.lang.String parameterName,
                                           java.lang.String entryName,
                                           java.lang.String defaultValue)
```
    Returns the configuration value of the specified entry or null if it is not set.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - getParamConfDate
```
public java.util.Date getParamConfDate(ActivityConstants.AccessType accessType,
                                       java.lang.String parameterName,
                                       java.lang.String entryName,
                                       java.util.Date defaultValue)
```
    Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as DATE. In the latter case a warning is logged.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - getParamConfURI
```
public java.net.URI getParamConfURI(ActivityConstants.AccessType accessType,
                                    java.lang.String parameterName,
                                    java.lang.String entryName,
                                    java.net.URI defaultValue)
```
    Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as URI. In the latter case a warning is logged.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - getParamConfUDT
```
public byte[] getParamConfUDT(ActivityConstants.AccessType accessType,
                              java.lang.String parameterName,
                              java.lang.String entryName,
                              byte[] defaultValue)
```
    Returns the configuration value of the specified entry or the given default value if it is not set or could not be parsed as USERDEFINED. In the latter case a warning is logged.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    defaultValue - the default value that will be returned if the configuration value is missing; may be null
    
    Returns:
    
    the configuration value or the given default value
  - requireParamConfBoolean
```
public boolean requireParamConfBoolean(ActivityConstants.AccessType accessType,
                                       java.lang.String parameterName,
                                       java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing or cannot be parsed as BOOLEAN
  - requireParamConfInteger
```
public long requireParamConfInteger(ActivityConstants.AccessType accessType,
                                    java.lang.String parameterName,
                                    java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing or cannot be parsed as INTEGER
  - requireParamConfFloat
```
public double requireParamConfFloat(ActivityConstants.AccessType accessType,
                                    java.lang.String parameterName,
                                    java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing or cannot be parsed as FLOAT
  - requireParamConfString
```
public java.lang.String requireParamConfString(ActivityConstants.AccessType accessType,
                                               java.lang.String parameterName,
                                               java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value; never null
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing
  - requireParamConfDate
```
public java.util.Date requireParamConfDate(ActivityConstants.AccessType accessType,
                                           java.lang.String parameterName,
                                           java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value; never null
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing or cannot be parsed as DATE
  - requireParamConfURI
```
public java.net.URI requireParamConfURI(ActivityConstants.AccessType accessType,
                                        java.lang.String parameterName,
                                        java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value; never null
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing or cannot be parsed as URI
  - requireParamConfUDT
```
public byte[] requireParamConfUDT(ActivityConstants.AccessType accessType,
                                  java.lang.String parameterName,
                                  java.lang.String entryName)
```
    Returns the configuration value of the specified entry or throws an exception if it is not available.
    
    Parameters:
    
    accessType - the access type of the parameter
    
    parameterName - the name of the parameter
    
    entryName - name of the configuration entry
    
    Returns:
    
    the configuration value; never null
    
    Throws:
    
    ApplicationEnvironmentException - if the value is missing or cannot be parsed as USERDEFINED
  - getActInstConfValue
```
protected java.lang.Object getActInstConfValue(java.lang.String entryName,
                                               ProcessConstants.AdeptDataType expDt,
                                               boolean required,
                                               java.lang.Object defValue)
```
    Gets the designated activity instance configuration value and logs messages or throws exceptions if it is not present.
    
    Parameters:
    
    entryName - the name of the configuration entry for which to retrieve the value.
    
    expDt - The expected data type of the configuration value.
    
    required - Whether the configuration value is required and an ApplicationEnvironmentException is to be thrown in case it is not present.
    
    defValue - The default value to be used in case the configuration value is optional and not set.
    
    Returns:
    
    The corresponding configuration value.
  - getParamConfValue
```
protected java.lang.Object getParamConfValue(ActivityConstants.AccessType accessType,
                                             java.lang.String parameterName,
                                             java.lang.String entryName,
                                             ProcessConstants.AdeptDataType expDt,
                                             boolean required,
                                             java.lang.Object defValue)
```
    Gets the designated parameter configuration value and logs messages or throws exceptions if it is not present.
    
    Parameters:
    
    accessType - The access type of the parameter.
    
    parameterName - The name of the parameter.
    
    entryName - the name of the configuration entry for which to retrieve the value.
    
    expDt - The expected data type of the configuration value.
    
    required - Whether the configuration value is required and an ApplicationEnvironmentException is to be thrown in case it is not present.
    
    defValue - The default value to be used in case the configuration value is optional and not set.
    
    Returns:
    
    The corresponding configuration value.
  - getConfValue
```
protected java.lang.Object getConfValue(Configuration conf,
                                        java.lang.String entryName,
                                        ProcessConstants.AdeptDataType expDt,
                                        boolean required,
                                        java.lang.Object defValue,
                                        java.lang.String paramText)
```
    Gets the designated configuration value and logs messages or throws exceptions if it is not present.
    
    Parameters:
    
    conf - The configuration to retrieve the value from.
    
    entryName - the name of the configuration entry for which to retrieve the value.
    
    expDt - The expected data type of the configuration value.
    
    required - Whether the configuration value is required and an ApplicationEnvironmentException is to be thrown in case it is not present.
    
    defValue - The default value to be used in case the configuration value is optional and not set.
    
    paramText - The additional text used for logging or the exceptions in case of a parameter configuration. This provides the name and the direction of the parameter. In case of the configuration of the activity instance this should be the empty string.
    
    Returns:
    
    The corresponding configuration value.
  - getParametersSortedByPosition
```
public static java.util.Deque<ProcessModelParameter> getParametersSortedByPosition(java.util.Collection<? extends ProcessModelParameter> params)
```
    Gets the designated parameters sorted by the configured position. Parameters without a position will be ignored.
    
    Parameters:
    
    params - The parameters which to sort by their configured position.
    
    Returns:
    
    The designated parameters having a configuration for a position sorted by this position.

Class ActivityData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

activityInstance

dataContext

Constructor Detail

ActivityData

Method Detail

getCorrespondingJavaClass

getInputParams

getInputParam

requireInputParam

hasParam

hasInputParam

hasInputListParam

getInputTypes

hasInputValue

getInputValue

getInputValue

getInputValue

getInputValue

getInputValues

getDualInputValue

readInputBoolean

readInputInteger

readInputFloat

readInputString

readInputDate

readInputURI

readInputUDT

readInputList

requireInputBoolean

requireInputInteger

requireInputFloat

requireInputString

requireInputDate

requireInputURI

requireInputUDT

booleanToNativeTypedValue

integerToNativeTypedValue

floatToNativeTypedValue

stringToNativeTypedValue

dateToNativeTypedValue

userdefinedToNativeTypedValue

uriToNativeTypedValue

getStoredValue

getStoredValue

getStoredValue

getStoredValues

readOutputBoolean

readOutputInteger

readOutputFloat

readOutputString

readOutputDate

readOutputURI

readOutputUDT

getOutputParams

getOutputParam

requireOutputParam

hasOutputParam

writeOutputValue

writeOutputValue

writeOutputValue

writeOutputValues

unwriteOutputValue

writeOutputBoolean

writeOutputInteger

writeOutputFloat

writeOutputString

writeOutputDate

writeOutputURI

writeOutputUDT

writeOutputUDT

writeOutputList

writeOutputList

writeOutputObject