Package de.aristaflow.adept2.model.datamanagement

Interface InstanceDataContainer

All Superinterfaces:

AutoCloseable, Cloneable, Closeable, DataContainer, InputDataContainer, PluginDataContainer, Serializable, TypedCloneable<DataContainer>, UserAttributeContainer

public interface InstanceDataContainer
extends DataContainer

An instance data container extends a normal DataContainer and allows to conveniently set the input parameters and retrieve the output parameters of a process instance. Input parameters which are not set have an value of Null. Output parameters may be Null so check before reading the values.

Field Summary

Fields

Modifier and Type	Field	Description
static long	serialVersionUID	Generated ID for serialisation.

Method Summary

Modifier and Type	Method	Description
void	setBoolean(String parameterName, boolean value)	Sets the BOOLEAN value of the designated instance input parameter.
void	setDate(String parameterName, Date value)	Sets the DATE value of the designated instance input parameter.
void	setFloat(String parameterName, double value)	Sets the FLOAT value of the designated instance input parameter.
void	setInteger(String parameterName, long value)	Sets the INTEGER value of the designated instance input parameter.
void	setNull(String parameterName)	Sets the value of the designated instance input parameter to NULL, which means the value is undefined.
void	setString(String parameterName, String value)	Sets the string value of the designated instance input parameter.
void	setUDT(String parameterName, UDTValue value)	Sets the value of the designated instance input parameter of the process instance and the corresponding metadata which is the writing node and its current iteration.
void	setURI(String parameterName, URI value)	Sets the URI value of the designated instance input parameter.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface de.aristaflow.adept2.model.datamanagement.DataContainer

clone, getInstanceID, getLastSavepoint, getNodeID, getNodeIteration, getSavepoints, getUnsavedIgnoredParameters, getUnsavedSavepoints, getUnsavedSessionState, getUnsavedTypes, getUnsavedValues, ignoredValue, ignoreValue, isReadOnly, restoreSessionState, savedSavepoints, setSavepoint, storeBoolean, storeDate, storedBoolean, storedDate, storedFloat, storedInteger, storedString, storedUDT, storedURI, storeFloat, storeInteger, storeSessionState, storeString, storeUDT, storeURI

Methods inherited from interface de.aristaflow.adept2.model.datamanagement.InputDataContainer

isNull, retrieveBoolean, retrieveDate, retrieveFloat, retrieveInteger, retrieveString, retrieveUDT, retrieveURI

Methods inherited from interface de.aristaflow.adept2.model.common.PluginDataContainer

getPluginData, getPluginDatas, getSupportedPlugins

Methods inherited from interface de.aristaflow.adept2.model.common.UserAttributeContainer

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

Field Detail

serialVersionUID

static final long serialVersionUID

Generated ID for serialisation.

See Also:

Constant Field Values

Method Detail

setNull

void setNull(String parameterName)
      throws NoSuchParameterException

Sets the value of the designated instance input parameter to NULL, which means the value is undefined.

Parameters:

parameterName - The name of the instance input parameter to be set to null.

Throws:

NoSuchParameterException - If the instance input parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

setInteger

void setInteger(String parameterName,
                long value)
         throws InvalidDataTypeException,
                NoSuchParameterException

Sets the INTEGER value of the designated instance input parameter.

Parameters:

parameterName - The name of the instance input parameter to be set.

value - The value as Java-type long of the instance input parameter of ADEPT2-type INTEGER.

Throws:

InvalidDataTypeException - If the designated instance input parameter is not of type INTEGER, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the instance input parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.INTEGER

setFloat

void setFloat(String parameterName,
              double value)
       throws InvalidDataTypeException,
              NoSuchParameterException

Sets the FLOAT value of the designated instance input parameter.

Parameters:

parameterName - The name of the instance input parameter to be set.

value - The value as Java-type double of the instance input parameter of ADEPT2-type FLOAT.

Throws:

InvalidDataTypeException - If the designated instance input parameter is not of type FLOAT, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.FLOAT

setBoolean

void setBoolean(String parameterName,
                boolean value)
         throws InvalidDataTypeException,
                NoSuchParameterException

Sets the BOOLEAN value of the designated instance input parameter.

Parameters:

parameterName - The name of the instance input parameter to be set.

value - The value as Java-type boolean of the instance input parameter of ADEPT2-type BOOLEAN.

Throws:

InvalidDataTypeException - If the designated instance input parameter is not of type BOOLEAN, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the instance input parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.BOOLEAN

setString

void setString(String parameterName,
               String value)
        throws InvalidDataTypeException,
               NoSuchParameterException

Sets the string value of the designated instance input parameter.

Parameters:

parameterName - The name of the instance input parameter to be set.

value - The value as Java-type String of the instance input parameter of ADEPT2-type STRING.

Throws:

InvalidDataTypeException - If the designated instance input parameter is not of type STRING, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the instance input parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.STRING

setDate

void setDate(String parameterName,
             Date value)
      throws InvalidDataTypeException,
             NoSuchParameterException

Sets the DATE value of the designated instance input parameter.

Parameters:

parameterName - The name of the instance input parameter to be set.

value - The value as Java-type java.util.Date of the instance input parameter of ADEPT2-type DATE.

Throws:

InvalidDataTypeException - If the designated instance input parameter is not of type DATE, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the instance input parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.DATE

setURI

void setURI(String parameterName,
            URI value)
     throws InvalidDataTypeException,
            NoSuchParameterException

Sets the URI value of the designated instance input parameter.

Parameters:

parameterName - The name of the instance input parameter to be set.

value - The value as Java-type java.net.URI of the instance input parameter of ADEPT2-type URI.

Throws:

InvalidDataTypeException - If the designated parameter is not of type URI, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.URI

setUDT

void setUDT(String parameterName,
            UDTValue value)
     throws InvalidDataTypeException,
            NoSuchParameterException

Sets the value of the designated instance input parameter of the process instance and the corresponding metadata which is the writing node and its current iteration.

Parameters:

parameterName - The name of the instance input parameter to be read.

value - The value of the instance input parameter of ADEPT2-type USERDEFINED. The caller is responsible for closing.

Throws:

InvalidDataTypeException - If the designated instance input parameter is not of type USERDEFINED, an InvalidDataTypeException will be raised.

NoSuchParameterException - If the instance input parameter of the designated name does not exist, a NoSuchParameterException will be thrown.

See Also:

ProcessConstants.AdeptDataType.USERDEFINED