de.aristaflow.adept2.core.datamanager

Interface ProcessUnawareAccess

public interface ProcessUnawareAccess

This interface provides access to the values of data elements for clients which do not have any process knowledge. These may be components that are outside the scope of a process or even outside the process-management-system. Since there is no defined scope for external access, clients may retrieve either the most recently written value or the most recent value written by an external component. When writing a data element from outside the system, the value is not taken into account for process-aware access. If the assumed data access, that is the triple instance-ID, node-ID and dataelement-ID, does not exist at a called method, an IllegalArgumentException will be thrown.

Unlike ProcessAwareAccess the methods of this interface do not support intermediate values. All externally written values are valid instantly. Intermediate results of process aware components are not accessible by this interface.

NULL-values are also managed by this interfaces. NULL represents an undefined value for the process-management-system because of not setting or consuming a value or an explicit NULL value set by an application.

Author:

Ulrich Kreher

See Also:

ProcessAwareAccess

Method Summary

Modifier and Type	Method and Description
InputDataContainer	getInputDataContainer(SessionToken session, Instance instance, java.util.Set<java.lang.Integer> dataElementIDs) Gets an input data container providing the most recent values of the designated data element IDs.
ParameterDataContext	getPublicDataContext(SessionToken session, Instance instance) Gets the data context providing the most recent values of the public data elements of the designated instance.
boolean	isExternalValueNull(SessionToken session, java.util.UUID instanceID, int dataElementID) Returns whether the value of the designated data element for the specified node is set to NULL by an external application.
boolean	isLatestValueNull(SessionToken session, java.util.UUID instanceID, int dataElementID) Returns whether the value of the designated data element for the specified node is NULL which means the data element has not been written or has been consumed yet by a process-aware application or has been explicitly set to NULL by a process-aware-application.
boolean	retrieveExternalBooleanValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent boolean value of the designated data element of type BOOLEAN written by an external component.
java.util.Date	retrieveExternalDateValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent date value of the designated data element of type DATE written by an external component.
double	retrieveExternalFloatValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent double value of the designated data element of type FLOAT written by an external component.
long	retrieveExternalIntegerValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent long value of the designated data element of type INTEGER written by an external component.
java.lang.String	retrieveExternalStringValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent string value of the designated data element of type STRING written by an external component or null if the data element has not been written externally yet.
UDTValue	retrieveExternalUDTValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent (proxy of the) value of the designated data element of user-defined type (UDT) written by an external component or null if the data element has not been written externally yet.
ServerUDTInputStream	retrieveExternalUDTValueIncrementally(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent (proxy of the) value of the designated data element of user-defined type (UDT) written by an external component or null if the data element has not been written externally yet as ServerUDTInputStream.
java.net.URI	retrieveExternalURIValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent URI value of the designated data element of type URI written by an external component or null if the data element has not been written externally yet.
boolean	retrieveLatestBooleanValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent boolean value of the designated data element of type BOOLEAN for the specified process instance.
java.util.Date	retrieveLatestDateValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent date value of the designated data element of type DATE for the specified process instance.
double	retrieveLatestFloatValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent double value of the designated data element of type FLOAT for the specified process instance.
long	retrieveLatestIntegerValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent long value of the designated data element of type INTEGER for the specified process instance.
java.lang.String	retrieveLatestStringValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent string value of the designated data element of type STRING for the specified process instance.
UDTValue	retrieveLatestUDTValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent (proxy of the) value of the designated data element of user-defined type (UDT) for the specified process instance.
ServerUDTInputStream	retrieveLatestUDTValueIncrementally(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent value of the designated data element of user-defined type (UDT) for the specified process instance as ServerUDTInputStream.
java.net.URI	retrieveLatestURIValue(SessionToken session, java.util.UUID instanceID, int dataElementID) Retrieves the most recent URI value of the designated data element of type URI for the specified process instance.
void	setNullExternal(SessionToken session, java.util.UUID instanceID, int dataElementID) Sets the value of the designated data element as external value to NULL, which means the value is undefined.
void	storeBooleanExternal(SessionToken session, java.util.UUID instanceID, int dataElementID, boolean value) Stores the boolean value of the designated data element of the process instance as external value.
void	storeDateExternal(SessionToken session, java.util.UUID instanceID, int dataElementID, java.util.Date value) Stores the date value of the designated data element of the process instance as external value.
void	storeFloatExternal(SessionToken session, java.util.UUID instanceID, int dataElementID, double value) Stores the double value of the designated data element of the process instance as external value.
void	storeIntegerExternal(SessionToken session, java.util.UUID instanceID, int dataElementID, long value) Stores the long value of the designated data element of the process instance as external value.
void	storeStringExternal(SessionToken session, java.util.UUID instanceID, int dataElementID, java.lang.String value) Stores the string value of the designated data element of the process instance as external value.
void	storeUDTExternal(SessionToken session, java.util.UUID instanceID, int dataElementID, UDTValue value) Stores the value of the designated data element of the process instance as external value.
void	storeURIExternal(SessionToken session, java.util.UUID instanceID, int dataElementID, java.net.URI value) Stores the URI value of the designated data element of the process instance as external value.

Method Detail

isLatestValueNull

boolean isLatestValueNull(SessionToken session,
                          java.util.UUID instanceID,
                          int dataElementID)

Returns whether the value of the designated data element for the specified node is NULL which means the data element has not been written or has been consumed yet by a process-aware application or has been explicitly set to NULL by a process-aware-application. This method has to be called before retrieving a latest 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.

instanceID - The (logical) ID of the process instance which houses the requested data element.

dataElementID - The ID of the requested data element.

Returns:

true if the value of the designated data element is NULL and therefore has not been written or has been consumed yet by a process-aware application.

retrieveLatestIntegerValue

long retrieveLatestIntegerValue(SessionToken session,
                                java.util.UUID instanceID,
                                int dataElementID)
                         throws InvalidDataTypeException

Retrieves the most recent long value of the designated data element of type INTEGER for the specified process instance.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recent value of the data element of ADEPT2-type INTEGER and of Java-type long.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.INTEGER

retrieveLatestFloatValue

double retrieveLatestFloatValue(SessionToken session,
                                java.util.UUID instanceID,
                                int dataElementID)
                         throws InvalidDataTypeException

Retrieves the most recent double value of the designated data element of type FLOAT for the specified process instance.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recent value of the data element of ADEPT2-type FLOAT and of Java-type long.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.FLOAT

retrieveLatestBooleanValue

boolean retrieveLatestBooleanValue(SessionToken session,
                                   java.util.UUID instanceID,
                                   int dataElementID)
                            throws InvalidDataTypeException

Retrieves the most recent boolean value of the designated data element of type BOOLEAN for the specified process instance.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recent value of the data element of ADEPT2-type BOOLEAN and of Java-type boolean.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.BOOLEAN

retrieveLatestStringValue

java.lang.String retrieveLatestStringValue(SessionToken session,
                                           java.util.UUID instanceID,
                                           int dataElementID)
                                    throws InvalidDataTypeException

Retrieves the most recent string value of the designated data element of type STRING for the specified process instance.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recent value of the data element of ADEPT2-type STRING and of Java-type String.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.STRING

retrieveLatestDateValue

java.util.Date retrieveLatestDateValue(SessionToken session,
                                       java.util.UUID instanceID,
                                       int dataElementID)
                                throws InvalidDataTypeException

Retrieves the most recent date value of the designated data element of type DATE for the specified process instance.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recent value of the data element of ADEPT2-type DATE and of Java-type java.util.Date.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.DATE

retrieveLatestURIValue

java.net.URI retrieveLatestURIValue(SessionToken session,
                                    java.util.UUID instanceID,
                                    int dataElementID)
                             throws InvalidDataTypeException

Retrieves the most recent URI value of the designated data element of type URI for the specified process instance.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recent value of the data element of ADEPT2-type URI and of Java-type java.net.URI.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.URI

retrieveLatestUDTValue

UDTValue retrieveLatestUDTValue(SessionToken session,
                                java.util.UUID instanceID,
                                int dataElementID)
                         throws InvalidDataTypeException

Retrieves the most recent (proxy of the) value of the designated data element of user-defined type (UDT) for the specified process instance.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recent value of the data element of ADEPT2-type USERDEFINED and of Java-type UDTValue.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.USERDEFINED

retrieveLatestUDTValueIncrementally

ServerUDTInputStream retrieveLatestUDTValueIncrementally(SessionToken session,
                                                         java.util.UUID instanceID,
                                                         int dataElementID)
                                                  throws InvalidDataTypeException

Retrieves the most recent value of the designated data element of user-defined type (UDT) for the specified process instance as ServerUDTInputStream. The server input stream does not provide the complete content of the underlying resource but a proxy object requesting the content incrementally when transfered via the communication.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recent value of the data element of ADEPT2-type USERDEFINED as ServerUDTInputStream, that is, clients do not retrieve all of the content of the stream at once but incrementally.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.USERDEFINED

getPublicDataContext

ParameterDataContext getPublicDataContext(SessionToken session,
                                          Instance instance)

Gets the data context providing the most recent values of the public data elements of the designated instance. The data context has the latest values of the public data elements which means, they are rather arbitrary.
The current iteration of the designated node is inferred from the instance. The instance object itself will not be stored in the data context and may therefore be unlocked afterwards.
This method is for use from inside ADEPT2 when the calling component already has a reference to an instance and maybe also locked the instance.

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.

instance - The instance which houses the public data elements to be accessed.

Returns:

The parameter data context providing the most recent values of the public data elements of the designated instance.

getInputDataContainer

InputDataContainer getInputDataContainer(SessionToken session,
                                         Instance instance,
                                         java.util.Set<java.lang.Integer> dataElementIDs)

Gets an input data container providing the most recent values of the designated data element IDs. The parameter names of the data container equal the names of the specified data elements. This also applies to the parameter/data element types.

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.

instance - The instance which houses the data elements to be accessed.

dataElementIDs - The IDs of the data elements for which to retrieve the values encapsulated in a data container.

Returns:

An input data container providing the most recent values of the designated data element IDs via the name and the type of these data elements.

isExternalValueNull

boolean isExternalValueNull(SessionToken session,
                            java.util.UUID instanceID,
                            int dataElementID)

Returns whether the value of the designated data element for the specified node is set to NULL by an external application. This method has to be called before retrieving a value externally.

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.

instanceID - The (logical) ID of the process instance which houses the requested data element.

dataElementID - The ID of the requested data element.

Returns:

true if the value of the specified data element is NULL and therefore has been set to NULL by a preceding external application.

retrieveExternalIntegerValue

long retrieveExternalIntegerValue(SessionToken session,
                                  java.util.UUID instanceID,
                                  int dataElementID)
                           throws InvalidDataTypeException

Retrieves the most recent long value of the designated data element of type INTEGER written by an external component.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recently externally written value of the data element of ADEPT2-type INTEGER and of Java-type long.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.INTEGER

retrieveExternalFloatValue

double retrieveExternalFloatValue(SessionToken session,
                                  java.util.UUID instanceID,
                                  int dataElementID)
                           throws InvalidDataTypeException

Retrieves the most recent double value of the designated data element of type FLOAT written by an external component.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recently externally written value of the data element of ADEPT2-type FLOAT and of Java-type double.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.FLOAT

retrieveExternalBooleanValue

boolean retrieveExternalBooleanValue(SessionToken session,
                                     java.util.UUID instanceID,
                                     int dataElementID)
                              throws InvalidDataTypeException

Retrieves the most recent boolean value of the designated data element of type BOOLEAN written by an external component.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recently externally written value of the data element of ADEPT2-type BOOLEAN and of Java-type boolean.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.BOOLEAN

retrieveExternalStringValue

java.lang.String retrieveExternalStringValue(SessionToken session,
                                             java.util.UUID instanceID,
                                             int dataElementID)
                                      throws InvalidDataTypeException

Retrieves the most recent string value of the designated data element of type STRING written by an external component or null if the data element has not been written externally yet.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recently externally written value of the data element of ADEPT2-type STRING and of Java-type String or null.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.STRING

retrieveExternalDateValue

java.util.Date retrieveExternalDateValue(SessionToken session,
                                         java.util.UUID instanceID,
                                         int dataElementID)
                                  throws InvalidDataTypeException

Retrieves the most recent date value of the designated data element of type DATE written by an external component.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recently externally written value of the data element of ADEPT2-type DATE and of Java-type java.util.Date.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.DATE

retrieveExternalURIValue

java.net.URI retrieveExternalURIValue(SessionToken session,
                                      java.util.UUID instanceID,
                                      int dataElementID)
                               throws InvalidDataTypeException

Retrieves the most recent URI value of the designated data element of type URI written by an external component or null if the data element has not been written externally yet.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recently externally written value of the data element of ADEPT2-type URI and of Java-type java.net.URI or null.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.URI

retrieveExternalUDTValue

UDTValue retrieveExternalUDTValue(SessionToken session,
                                  java.util.UUID instanceID,
                                  int dataElementID)
                           throws InvalidDataTypeException

Retrieves the most recent (proxy of the) value of the designated data element of user-defined type (UDT) written by an external component or null if the data element has not been written externally yet.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recently externally written value of the data element of ADEPT2-type USERDEFINED and of Java-type UDTValue or null.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.USERDEFINED

retrieveExternalUDTValueIncrementally

ServerUDTInputStream retrieveExternalUDTValueIncrementally(SessionToken session,
                                                           java.util.UUID instanceID,
                                                           int dataElementID)
                                                    throws InvalidDataTypeException

Retrieves the most recent (proxy of the) value of the designated data element of user-defined type (UDT) written by an external component or null if the data element has not been written externally yet as ServerUDTInputStream. The server input stream does not provide the complete content of the underlying resource but a proxy object requesting the content incrementally when transfered via the communication.

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.

instanceID - The (logical) ID of the process instance which houses the data element to be read.

dataElementID - The ID of the data element to be read.

Returns:

The most recently externally written value of the data element of ADEPT2-type USERDEFINED as ServerUDTInputStream, that is, clients do not retrieve all of the content of the stream at once but incrementally.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.USERDEFINED

setNullExternal

void setNullExternal(SessionToken session,
                     java.util.UUID instanceID,
                     int dataElementID)

Sets the value of the designated data element as external value to NULL, which means the value is undefined.

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.

instanceID - The (logical) ID of the process instance which houses the manipulated data element.

dataElementID - The ID of the manipulated data element.

storeIntegerExternal

void storeIntegerExternal(SessionToken session,
                          java.util.UUID instanceID,
                          int dataElementID,
                          long value)
                   throws InvalidDataTypeException

Stores the long value of the designated data element of the process instance as external value. An external value is not considered for applications started from inside the process instance or for applications that are process-aware.

Parameters:

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

instanceID - The (logical) ID of the process instance which houses the data element to be written.

dataElementID - The ID of the data element to be written.

value - The value as Java-type long of the data element of ADEPT2-type INTEGER.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.INTEGER

storeFloatExternal

void storeFloatExternal(SessionToken session,
                        java.util.UUID instanceID,
                        int dataElementID,
                        double value)
                 throws InvalidDataTypeException

Stores the double value of the designated data element of the process instance as external value. An external value is not considered for applications started from inside the process instance or for applications that are process-aware.

Parameters:

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

instanceID - The (logical) ID of the process instance which houses the data element to be written.

dataElementID - The ID of the data element to be written.

value - The value as Java-type double of the data element of ADEPT2-type FLOAT.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.FLOAT

storeBooleanExternal

void storeBooleanExternal(SessionToken session,
                          java.util.UUID instanceID,
                          int dataElementID,
                          boolean value)
                   throws InvalidDataTypeException

Stores the boolean value of the designated data element of the process instance as external value. An external value is not considered for applications started from inside the process instance or for applications that are process-aware.

Parameters:

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

instanceID - The (logical) ID of the process instance which houses the data element to be written.

dataElementID - The ID of the data element to be written.

value - The value as Java-type boolean of the data element of ADEPT2-type BOOLEAN.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.BOOLEAN

storeStringExternal

void storeStringExternal(SessionToken session,
                         java.util.UUID instanceID,
                         int dataElementID,
                         java.lang.String value)
                  throws InvalidDataTypeException

Stores the string value of the designated data element of the process instance as external value. An external value is not considered for applications started from inside the process instance or for applications that are process-aware.

Parameters:

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

instanceID - The (logical) ID of the process instance which houses the data element to be written.

dataElementID - The ID of the data element to be written.

value - The value as Java-type String of the data element of ADEPT2-type STRING. This must not be null.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.STRING

storeDateExternal

void storeDateExternal(SessionToken session,
                       java.util.UUID instanceID,
                       int dataElementID,
                       java.util.Date value)
                throws InvalidDataTypeException

Stores the date value of the designated data element of the process instance as external value. An external value is not considered for applications started from inside the process instance or for applications that are process-aware.

Parameters:

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

instanceID - The (logical) ID of the process instance which houses the data element to be written.

dataElementID - The ID of the data element to be written.

value - The value as Java-type java.util.Date of the data element of ADEPT2-type DATE. This must not be null.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.DATE

storeURIExternal

void storeURIExternal(SessionToken session,
                      java.util.UUID instanceID,
                      int dataElementID,
                      java.net.URI value)
               throws InvalidDataTypeException

Stores the URI value of the designated data element of the process instance as external value. An external value is not considered for applications started from inside the process instance or for applications that are process-aware.

Parameters:

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

instanceID - The (logical) ID of the process instance which houses the data element to be written.

dataElementID - The ID of the data element to be written.

value - The value as Java-type java.net.URI of the data element of ADEPT2-type URI. This must not be null.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.URI

storeUDTExternal

void storeUDTExternal(SessionToken session,
                      java.util.UUID instanceID,
                      int dataElementID,
                      UDTValue value)
               throws InvalidDataTypeException

Stores the value of the designated data element of the process instance as external value. An external value is not considered for applications started from inside the process instance or for applications that are process-aware.

Parameters:

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

instanceID - The (logical) ID of the process instance which houses the data element to be written.

dataElementID - The ID of the data element to be written.

value - The value of the data element of ADEPT2-type USERDEFINED. This must not be null.

Throws:

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

See Also:

ProcessConstants.AdeptDataType.USERDEFINED