de.aristaflow.adept2.model.datamanagement

Interface InputDataContainer

All Superinterfaces:

PluginDataContainer, java.io.Serializable, UserAttributeContainer

All Known Subinterfaces:

DataContainer, IndexedAccessDataContainer, InstanceDataContainer

public interface InputDataContainer
extends java.io.Serializable, UserAttributeContainer, PluginDataContainer

This interface encapsulates the data context of an application for read-only accessing the values of input parameters of an application. The methods resemble the retrieval methods in ProcessAwareAccess but with less information. When using DataContainer only the name of the corresponding parameter and a session token is necessary since all other information (instance, data element, agent,...) is already provided when retrieving the container.
The data container may be lazy, which means, it retrieves the values of the data elements when they are accessed. It is also allowed to be eager and store all values internally and it may be in-between, for instance, store simple values internally and retrieve big values lazily.

Implementations of this interface may not store an Instance internally since a process instance must be accessible by other components. Instead, all needed information has to be encapsulated in the container. The instance may be provided, for instance, in the constructor, but the reference to it has to be released afterwards.

Author:

Ulrich Kreher

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
boolean	isNull(SessionToken session, java.lang.String parameterName) Returns whether the value of the designated input parameter is NULL which means the data element has not been written or has been consumed yet or has been explicitly set to NULL by a previous application.
boolean	retrieveBoolean(SessionToken session, java.lang.String parameterName) Retrieves the boolean value of the designated input parameter of type BOOLEAN.
java.util.Date	retrieveDate(SessionToken session, java.lang.String parameterName) Retrieves the date value of the designated input parameter of type DATE.
double	retrieveFloat(SessionToken session, java.lang.String parameterName) Retrieves the double value of the designated input parameter of type FLOAT.
long	retrieveInteger(SessionToken session, java.lang.String parameterName) Retrieves the long value of the designated input parameter of type INTEGER.
java.lang.String	retrieveString(SessionToken session, java.lang.String parameterName) Retrieves the string value of the designated input parameter of type STRING.
UDTValue	retrieveUDT(SessionToken session, java.lang.String parameterName) Retrieves (the proxy of) the value of the designated input parameter of user-defined type (UDT).
java.net.URI	retrieveURI(SessionToken session, java.lang.String parameterName) Retrieves the URI value of the designated input parameter of type URI.

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

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

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

getPluginData, getPluginDatas, getSupportedPlugins

Field Detail

serialVersionUID

static final long serialVersionUID

Generated ID for serialisation.

See Also:

Constant Field Values

Method Detail

isNull

boolean isNull(SessionToken session,
               java.lang.String parameterName)
        throws NoSuchParameterException

Returns whether the value of the designated input parameter is NULL which means the data element has not been written or has been consumed yet or has been explicitly set to NULL by a previous application. This method has to be called before retrieving a value.

Parameters:

session - The session which is used to check for access rights on this method and to retrieve the accessing agent and the corresponding organisational position.

parameterName - The name of the input parameter to check for NULL.

Returns:

true if the value of the designated input parameter is NULL and therefore has not been written or has been consumed yet.

Throws:

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

retrieveInteger

long retrieveInteger(SessionToken session,
                     java.lang.String parameterName)
              throws InvalidDataTypeException,
                     NoSuchParameterException

Retrieves the long value of the designated input parameter of type INTEGER. In case of NULL the value returned by this method is arbitrary and therefore must not be used.

Parameters:

session - The session which is used to check for access rights on this method and to retrieve the accessing agent and the corresponding organisational position.

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

Returns:

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

Throws:

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

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

See Also:

ProcessConstants.AdeptDataType.INTEGER

retrieveFloat

double retrieveFloat(SessionToken session,
                     java.lang.String parameterName)
              throws InvalidDataTypeException,
                     NoSuchParameterException

Retrieves the double value of the designated input parameter of type FLOAT. In case of NULL the value returned by this method is arbitrary and therefore must not be used.

Parameters:

session - The session which is used to check for access rights on this method and to retrieve the accessing agent and the corresponding organisational position.

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

Returns:

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

Throws:

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

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

See Also:

ProcessConstants.AdeptDataType.FLOAT

retrieveBoolean

boolean retrieveBoolean(SessionToken session,
                        java.lang.String parameterName)
                 throws InvalidDataTypeException,
                        NoSuchParameterException

Retrieves the boolean value of the designated input parameter of type BOOLEAN. In case of NULL the value returned by this method is arbitrary and therefore must not be used.

Parameters:

session - The session which is used to check for access rights on this method and to retrieve the accessing agent and the corresponding organisational position.

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

Returns:

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

Throws:

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

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

See Also:

ProcessConstants.AdeptDataType.BOOLEAN

retrieveString

java.lang.String retrieveString(SessionToken session,
                                java.lang.String parameterName)
                         throws InvalidDataTypeException,
                                NoSuchParameterException

Retrieves the string value of the designated input parameter of type STRING. In case of NULL the value returned by this method is arbitrary and therefore must not be used.

Parameters:

session - The session which is used to check for access rights on this method and to retrieve the accessing agent and the corresponding organisational position.

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

Returns:

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

Throws:

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

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

See Also:

ProcessConstants.AdeptDataType.STRING

retrieveDate

java.util.Date retrieveDate(SessionToken session,
                            java.lang.String parameterName)
                     throws InvalidDataTypeException,
                            NoSuchParameterException

Retrieves the date value of the designated input parameter of type DATE. In case of NULL the value returned by this method is arbitrary and therefore must not be used.

Parameters:

session - The session which is used to check for access rights on this method and to retrieve the accessing agent and the corresponding organisational position.

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

Returns:

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

Throws:

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

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

See Also:

ProcessConstants.AdeptDataType.DATE

retrieveURI

java.net.URI retrieveURI(SessionToken session,
                         java.lang.String parameterName)
                  throws InvalidDataTypeException,
                         NoSuchParameterException

Retrieves the URI value of the designated input parameter of type URI. In case of NULL the value returned by this method is arbitrary and therefore must not be used.

Parameters:

session - The session which is used to check for access rights on this method and to retrieve the accessing agent and the corresponding organisational position.

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

Returns:

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

Throws:

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

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

See Also:

ProcessConstants.AdeptDataType.URI

retrieveUDT

UDTValue retrieveUDT(SessionToken session,
                     java.lang.String parameterName)
              throws InvalidDataTypeException,
                     NoSuchParameterException

Retrieves (the proxy of) the value of the designated input parameter of user-defined type (UDT). In case of NULL the value returned by this method is arbitrary and therefore must not be used.

Parameters:

session - The session which is used to check for access rights on this method and to retrieve the accessing agent and the corresponding organisational position.

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

Returns:

The value of the input parameter of ADEPT2-type USERDEFINED and of Java-type UDTValue.

Throws:

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

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

See Also:

ProcessConstants.AdeptDataType.USERDEFINED