public interface ProcessAwareAccess
IllegalArgumentException will be thrown.
The read value respects the ADEPT-metamodel, which means, the returned value is written by a preceding node of the reading node. Values that are written by nodes parallel branches (without synchronisation) must not be returned.
To allow for intermediate results, all written values are stored temporarily. A reading node will get its own values if they are written by the very same node. This will only apply if a node reads and also writes a specific data element. When completing the corresponding node, the temporary values have to be validated.
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 by an application.
Concurrent access to one data element is allowed. The ADEPT-metamodel defines how to handle this. Write accesses lead to a new version of a data value. Each value has a well-defined scope, that is, reading a data element returns a dedicated value. It also allows successive writing by one application, which just overwrites older values written by the application (same nodeID and same iteration).
| Modifier and Type | Method and Description |
|---|---|
void |
discardValue(SessionToken session,
java.util.UUID instanceID,
int discardingNodeID,
int discarderIteration,
int dataElementID)
Discards the value for the designated data element set before by the
designated node.
|
void |
discardValue(SessionToken session,
java.util.UUID instanceID,
int discardingNodeID,
int discarderIteration,
int dataElementID,
java.lang.String savepoint)
Discards the value for the designated data element set before by the
designated node.
|
void |
dropWrittenValues(SessionToken session,
Instance instance,
int nodeId,
int nodeIteration)
Drops all values written by the designated instance that have not been
validated yet,
that is, the values are removed (or marked as removed) from the data manager for all
savepoints.
|
boolean |
dropWrittenValuesBackTo(SessionToken session,
Instance instance,
int nodeId,
int nodeIteration,
java.lang.String savepoint)
Drops all values written by the designated instance that have not been
validated yet
back to the designated savepoint, that is, the values are removed (or marked as removed) from
the data manager for all savepoints after the designated one.
|
java.lang.String |
flushDataContainer(SessionToken session,
Instance instance,
int writingNodeId,
int writerIteration,
DataContainer dataContainer,
java.lang.String savepoint)
Flushes all values from the designated data container and persists them in
this data manager (if the corresponding data container stems from this data
manager) referring to it by the designated savepoint ID.
|
void |
flushSavepoint(SessionToken session,
Instance instance,
int writingNodeId,
int writerIteration,
DataContainer dataContainer,
java.lang.String savepoint)
Flushes the designated safepoint only.
|
DataContainer |
getDataContainer(SessionToken session,
Instance instance,
int nodeID)
Gets the data container for the application specified by the designated
activity.
|
InputDataContainer |
getNodeDataContainer(SessionToken session,
Instance instance,
int nodeID)
Gets the data container for the designated node.
|
DataContainer |
getObsoleteDataContainer(SessionToken session,
ExecutionHistory execHist,
Instance instance,
int nodeID,
int iteration)
Gets the data container for a finished application specified by the
designated node and iteration ID.
|
ParameterDataContext |
getPublicDataContext(SessionToken session,
Instance instance,
int nodeID)
Gets the data context providing all public data elements for the designated
node.
|
boolean |
isNull(SessionToken session,
java.util.UUID instanceID,
int readingNodeID,
int readerIteration,
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 or has been explicitly set to NULL by a previous application.
|
boolean |
retrieveBoolean(SessionToken session,
java.util.UUID instanceID,
int readingNodeID,
int readerIteration,
int dataElementID)
Retrieves the boolean value of the designated data element of type BOOLEAN valid for the
specified node of the process instance and its current iteration count.
|
java.util.Date |
retrieveDate(SessionToken session,
java.util.UUID instanceID,
int readingNodeID,
int readerIteration,
int dataElementID)
Retrieves the date value of the designated data element of type DATE valid for the specified
node of the process instance and its current iteration count.
|
double |
retrieveFloat(SessionToken session,
java.util.UUID instanceID,
int readingNodeID,
int readerIteration,
int dataElementID)
Retrieves the double value of the designated data element of type FLOAT valid for the specified
node of the process instance and its current iteration count.
|
long |
retrieveInteger(SessionToken session,
java.util.UUID instanceID,
int readingNodeID,
int readerIteration,
int dataElementID)
Retrieves the long value of the designated data element of type INTEGER valid for the specified
node of the process instance and its current iteration count.
|
java.lang.String |
retrieveString(SessionToken session,
java.util.UUID instanceID,
int readingNodeID,
int readerIteration,
int dataElementID)
Retrieves the string value of the designated data element of type STRING valid for the
specified node of the process instance and its current iteration count.
|
UDTValue |
retrieveUDT(SessionToken session,
java.util.UUID instanceID,
int readingNodeID,
int readerIteration,
int dataElementID)
Retrieves (the proxy of) the value of the designated data element of user-defined type (UDT)
valid for the specified node of the process instance and its current iteration count.
|
ServerUDTInputStream |
retrieveUDTIncrementally(SessionToken session,
java.util.UUID instanceID,
int readingNodeID,
int readerIteration,
int dataElementID)
Retrieves the value of the designated data element of user-defined type (UDT) valid for the
specified node of the process instance and its current iteration count as
ServerUDTInputStream. |
java.net.URI |
retrieveURI(SessionToken session,
java.util.UUID instanceID,
int readingNodeID,
int readerIteration,
int dataElementID)
Retrieves the URI value of the designated data element of type URI valid for the specified node
of the process instance and its current iteration count.
|
void |
storeBoolean(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
boolean value)
Stores an intermediate BOOLEAN value of the designated data element of the
process instance and the corresponding metadata which is the writing node
and its current iteration.
|
void |
storeBoolean(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
java.lang.String savepoint,
boolean value)
Stores an intermediate BOOLEAN value of the designated data element of the
process instance and the corresponding metadata which is the writing node
and its current iteration.
|
void |
storeDate(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
java.util.Date value)
Stores an intermediate DATE value of the designated data element of the
process instance and the corresponding metadata which is the writing node
and its current iteration.
|
void |
storeDate(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
java.lang.String savepoint,
java.util.Date value)
Stores an intermediate DATE value of the designated data element of the
process instance and the corresponding metadata which is the writing node
and its current iteration.
|
void |
storeFloat(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
double value)
Stores an intermediate FLOAT value of the designated data element of the
process instance and the corresponding metadata which is the writing node
and its current iteration.
|
void |
storeFloat(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
java.lang.String savepoint,
double value)
Stores an intermediate FLOAT value of the designated data element of the
process instance and the corresponding metadata which is the writing node
and its current iteration.
|
void |
storeInteger(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
long value)
Stores an intermediate INTEGER value of the designated data element of the
process instance and the corresponding metadata which is the writing node
and its current iteration.
|
void |
storeInteger(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
java.lang.String savepoint,
long value)
Stores an intermediate INTEGER value of the designated data element of the
process instance and the corresponding metadata which is the writing node
and its current iteration.
|
void |
storeString(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
java.lang.String value)
Stores an intermediate string value of the designated data element of the
process instance and the corresponding metadata which is the writing node
and its current iteration.
|
void |
storeString(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
java.lang.String savepoint,
java.lang.String value)
Stores an intermediate string value of the designated data element of the
process instance and the corresponding metadata which is the writing node
and its current iteration.
|
void |
storeUDT(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
java.lang.String savepoint,
UDTValue value)
Stores an intermediate value of the designated data element of the process
instance and the corresponding metadata which is the writing node and its
current iteration.
|
void |
storeUDT(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
UDTValue value)
Stores an intermediate value of the designated data element of the process
instance and the corresponding metadata which is the writing node and its
current iteration.
|
void |
storeURI(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
java.lang.String savepoint,
java.net.URI value)
Stores an intermediate URI value of the designated data element of the
process instance and the corresponding metadata which is the writing node
and its current iteration.
|
void |
storeURI(SessionToken session,
java.util.UUID instanceID,
int writingNodeID,
int writerIteration,
int dataElementID,
java.net.URI value)
Stores an intermediate URI value of the designated data element of the
process instance and the corresponding metadata which is the writing node
and its current iteration.
|
void |
validateWrittenValues(SessionToken session,
Instance instance,
int nodeId,
int nodeIteration,
java.lang.String savepoint)
Validates and verifies all values written by the designated node instance
for the designated savepoint, that is, the values are not temporary any
more but valid for the following nodes and it is checked whether all
mandatory output parameters have valid values.
|
boolean isNull(SessionToken session, java.util.UUID instanceID, int readingNodeID, int readerIteration, int dataElementID)
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.readingNodeID - The ID of the node which reads the value.readerIteration - The current iteration count of the reading node.dataElementID - The ID of the data element to be read.true if the value of the designated data element is
NULL and therefore has not been written or has been consumed yet.long retrieveInteger(SessionToken session, java.util.UUID instanceID, int readingNodeID, int readerIteration, int dataElementID) throws InvalidDataTypeException
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.readingNodeID - The ID of the node which reads the value.readerIteration - The current iteration count of the reading node.dataElementID - The ID of the data element to be read.long.InvalidDataTypeException - If the designated data element is not of
type INTEGER, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.INTEGERdouble retrieveFloat(SessionToken session, java.util.UUID instanceID, int readingNodeID, int readerIteration, int dataElementID) throws InvalidDataTypeException
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.readingNodeID - The ID of the node which reads the value.readerIteration - The current iteration count of the reading node.dataElementID - The ID of the data element to be read.double.InvalidDataTypeException - If the designated data element is not of
type FLOAT, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.FLOATboolean retrieveBoolean(SessionToken session, java.util.UUID instanceID, int readingNodeID, int readerIteration, int dataElementID) throws InvalidDataTypeException
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.readingNodeID - The ID of the node which reads the value.readerIteration - The current iteration count of the reading node.dataElementID - The ID of the data element to be read.boolean.InvalidDataTypeException - If the designated data element is not of
type BOOLEAN, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.BOOLEANjava.lang.String retrieveString(SessionToken session, java.util.UUID instanceID, int readingNodeID, int readerIteration, int dataElementID) throws InvalidDataTypeException
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.readingNodeID - The ID of the node which reads the value.readerIteration - The current iteration count of the reading node.dataElementID - The ID of the data element to be read.String.InvalidDataTypeException - If the designated data element is not of
type STRING, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.STRINGjava.util.Date retrieveDate(SessionToken session, java.util.UUID instanceID, int readingNodeID, int readerIteration, int dataElementID) throws InvalidDataTypeException
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.readingNodeID - The ID of the node which reads the value.readerIteration - The current iteration count of the reading node.dataElementID - The ID of the data element to be read.java.util.Date.InvalidDataTypeException - If the designated data element is not of
type DATE, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.DATEjava.net.URI retrieveURI(SessionToken session, java.util.UUID instanceID, int readingNodeID, int readerIteration, int dataElementID) throws InvalidDataTypeException
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.readingNodeID - The ID of the node which reads the value.readerIteration - The current iteration count of the reading node.dataElementID - The ID of the data element to be read.java.net.URI.InvalidDataTypeException - If the designated data element is not of
type URI, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.URIUDTValue retrieveUDT(SessionToken session, java.util.UUID instanceID, int readingNodeID, int readerIteration, int dataElementID) throws InvalidDataTypeException
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.readingNodeID - The ID of the node which reads the value.readerIteration - The current iteration count of the reading node.dataElementID - The ID of the data element to be read.UDTValue.InvalidDataTypeException - If the designated data element is not of
type USERDEFINED, an InvalidDataTypeException will
be raised.ProcessConstants.AdeptDataType.USERDEFINEDServerUDTInputStream retrieveUDTIncrementally(SessionToken session, java.util.UUID instanceID, int readingNodeID, int readerIteration, int dataElementID) throws InvalidDataTypeException
ServerUDTInputStream. This is either the last valid value or the intermediate
value written by the very same node in the current iteration which has not been validated yet.
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.readingNodeID - The ID of the node which reads the value.readerIteration - The current iteration count of the reading node.dataElementID - The ID of the data element to be read.ServerUDTInputStream, that is, clients do not retrieve
all of the content of the stream at once but incrementally.InvalidDataTypeException - If the designated data element is not of
type USERDEFINED, an InvalidDataTypeException will
be raised.ProcessConstants.AdeptDataType.USERDEFINEDParameterDataContext getPublicDataContext(SessionToken session, Instance instance, int nodeID)
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.nodeID - The ID of the node for which the parameter data context is
needed.InputDataContainer getNodeDataContainer(SessionToken session, Instance instance, int nodeID)
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.nodeID - The ID of the node for which the data container is needed.DataContainer getDataContainer(SessionToken session, Instance instance, int nodeID)
Intermediate values written to the data container may differ from the intermediate results in the data manager. This allows for caching in the data container.
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.nodeID - The ID of the node for which the data container is needed.void flushSavepoint(SessionToken session, Instance instance, int writingNodeId, int writerIteration, DataContainer dataContainer, java.lang.String savepoint) throws InvalidDataContainerException
flushDataContainer(SessionToken, Instance, int, int, DataContainer, String) and
provide null as savepoint.
In case the data container writes through or the designated savepoint has already been flushed, this is a no-op.
session - The session which is used to synchronise access and to check for access rights
on this method.instance - The instance which houses the data elements to be written.writingNodeId - The ID of the node for which the data container has been created.writerIteration - The iteration of the node for which the data container has been created.dataContainer - The data container providing the values for the designated node.savepoint - The savepoint for which to flush the data container. If a savepoint of this
name has already been persisted, it will be overwritten. If the savepoint is not set
in the designated data container, it will be ignored. This must neither be
null nor the empty string.InvalidDataContainerException - If the designated data container does not correspond to
the designated node data or it cannot be flushed due to other reasons, an
InvalidDataContainerException will be thrown.java.lang.String flushDataContainer(SessionToken session, Instance instance, int writingNodeId, int writerIteration, DataContainer dataContainer, java.lang.String savepoint) throws InvalidDataContainerException
null as savepoint.
In case the data container writes through, this is a no-op.
session - The session which is used to synchronise access and to check
for access rights on this method.instance - The instance which houses the data elements to be written.writingNodeId - The ID of the node for which the data container has
been created.writerIteration - The iteration of the node for which the data
container has been created.dataContainer - The data container providing the values for the
designated node.savepoint - The savepoint for which to flush the data container. If a
savepoint of this name has already been flushed, it will be
overwritten. If the savepoint is not set in the designated data
container, it will be set first and will then encompass the
current values of the data container. This must not be the empty
string! If this is null and there are unsaved
changes, the implicit savepoint will be used (and possibly
overwritten).InvalidDataContainerException - If the designated data container does
not correspond to the designated node data or it cannot be
flushed due to other reasons, an
InvalidDataContainerException will be thrown.DataContainer getObsoleteDataContainer(SessionToken session, ExecutionHistory execHist, Instance instance, int nodeID, int iteration) throws InvalidActivityStateException
InputDataContainer while
the output parameters have to be retrieved from
DataContainer. The data
container does not allow to write any values.
This method checks whether the designated node has been executed in the
designated iteration. If it has not, a
InvalidActivityStateException will be thrown since no valid
data container can be created, for instance, when a node has been skipped
or the iteration is in the future.
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.execHist - the execution history for the specified instanceinstance - The instance which houses the data elements to be accessed.nodeID - The ID of the node for which the data container is wanted.iteration - The iteration of the node of which to retrieve the data
container.stored*-methods. This data
container does not allow to store any value.InvalidActivityStateException - If the designated node has not been
executed for the current iteration (either it has been skipped or
it has not reached this iteration), a
InvalidActivityStateException will be thrown.void discardValue(SessionToken session, java.util.UUID instanceID, int discardingNodeID, int discarderIteration, int dataElementID)
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.discardingNodeID - The ID of the node which has written the value and
wants to discard it now.discarderIteration - The current iteration count of the node which has
written the value and wants to discard it now.dataElementID - The ID of the data element of which to discard the
value.void discardValue(SessionToken session, java.util.UUID instanceID, int discardingNodeID, int discarderIteration, int dataElementID, java.lang.String savepoint)
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.discardingNodeID - The ID of the node which has written the value and
wants to discard it now.discarderIteration - The current iteration count of the node which has
written the value and wants to discard it now.dataElementID - The ID of the data element of which to discard the
value.savepoint - The savepoint for which to discard the value. This must
not be the empty string! null discards for the next
implicit savepoint.void storeInteger(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, long value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.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.InvalidDataTypeException - If the designated data element is not of
type INTEGER, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.INTEGERvoid storeInteger(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, java.lang.String savepoint, long value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.dataElementID - The ID of the data element to be written.savepoint - The savepoint for which to store the value. This must
not be the empty string! null stores for the next
implicit savepoint.value - The value as Java-type long of the data element
of ADEPT2-type INTEGER.InvalidDataTypeException - If the designated data element is not of
type INTEGER, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.INTEGERvoid storeFloat(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, double value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.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.InvalidDataTypeException - If the designated data element is not of
type FLOAT, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.FLOATvoid storeFloat(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, java.lang.String savepoint, double value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.dataElementID - The ID of the data element to be written.savepoint - The savepoint for which to store the value. This must
not be the empty string! null stores for the next
implicit savepoint.value - The value as Java-type double of the data
element of ADEPT2-type FLOAT.InvalidDataTypeException - If the designated data element is not of
type FLOAT, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.FLOATvoid storeBoolean(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, boolean value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.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.InvalidDataTypeException - If the designated data element is not of
type BOOLEAN, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.BOOLEANvoid storeBoolean(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, java.lang.String savepoint, boolean value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.dataElementID - The ID of the data element to be written.savepoint - The savepoint for which to store the value. This must
not be the empty string! null stores for the next
implicit savepoint.value - The value as Java-type boolean of the data
element of ADEPT2-type BOOLEAN.InvalidDataTypeException - If the designated data element is not of
type BOOLEAN, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.BOOLEANvoid storeString(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, java.lang.String value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.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.InvalidDataTypeException - If the designated data element is not of
type STRING, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.STRINGvoid storeString(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, java.lang.String savepoint, java.lang.String value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.dataElementID - The ID of the data element to be written.savepoint - The savepoint for which to store the value. This must
not be the empty string! null stores for the next
implicit savepoint.value - The value as Java-type String of the data
element of ADEPT2-type STRING. This must not be null.InvalidDataTypeException - If the designated data element is not of
type STRING, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.STRINGvoid storeDate(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, java.util.Date value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.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.InvalidDataTypeException - If the designated data element is not of
type DATE, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.DATEvoid storeDate(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, java.lang.String savepoint, java.util.Date value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.dataElementID - The ID of the data element to be written.savepoint - The savepoint for which to store the value. This must
not be the empty string! null stores for the next
implicit savepoint.value - The value as Java-type java.util.Date of the data
element of ADEPT2-type DATE. This must not be null.InvalidDataTypeException - If the designated data element is not of
type DATE, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.DATEvoid storeURI(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, java.net.URI value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.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.InvalidDataTypeException - If the designated data element is not of
type URI, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.URIvoid storeURI(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, java.lang.String savepoint, java.net.URI value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.dataElementID - The ID of the data element to be written.savepoint - The savepoint for which to store the value. This must
not be the empty string! null stores for the next
implicit savepoint.value - The value as Java-type java.net.URI of the data
element of ADEPT2-type URI. This must not be null.InvalidDataTypeException - If the designated data element is not of
type URI, an InvalidDataTypeException will be
raised.ProcessConstants.AdeptDataType.URIvoid storeUDT(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, UDTValue value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.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.InvalidDataTypeException - If the designated data element is not of
type USERDEFINED, an InvalidDataTypeException will
be raised.ProcessConstants.AdeptDataType.USERDEFINEDvoid storeUDT(SessionToken session, java.util.UUID instanceID, int writingNodeID, int writerIteration, int dataElementID, java.lang.String savepoint, UDTValue value) throws InvalidDataTypeException
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.writingNodeID - The ID of the node which writes the value.writerIteration - The current iteration count of the writing node.dataElementID - The ID of the data element to be written.savepoint - The savepoint for which to store the value. This must
not be the empty string! null stores for the next
implicit savepoint.value - The value of the data element of ADEPT2-type USERDEFINED. This
must not be null.InvalidDataTypeException - If the designated data element is not of
type USERDEFINED, an InvalidDataTypeException will
be raised.ProcessConstants.AdeptDataType.USERDEFINEDvoid validateWrittenValues(SessionToken session, Instance instance, int nodeId, int nodeIteration, java.lang.String savepoint) throws ValidationFailedException
session - The session which is used to check for access rights on this
method and to retrieve the validating agent and the corresponding
organisational position.instance - The process instance for which a node is completed. This
requires that the caller of this method has an execution lock on
the instance.nodeId - The ID of the node for which to validate a savepoint.nodeIteration - The iteration of the node for which to validate a
savepoint.savepoint - The name of the savepoint which to validate. Be sure that
this savepoint has written all mandatory output parameters.
Otherwise validation may fail although this is not intended, e. g.
since the savepoint is not the final savepoint for this node. This
must not be the empty string! If this is null, the
implicit savepoint will be used.ValidationFailedException - If the validation fails, for instance due
to missing values of mandatory output parameters, a
ValidationFailedException will be thrown.void dropWrittenValues(SessionToken session, Instance instance, int nodeId, int nodeIteration)
flushing
data from a data container.session - The session which is used to check for access rights on this method and to
retrieve the dropping agent and the corresponding organisational position for logging
purpose.instance - The process instance for which a node is completed. This requires that the
caller of this method has a lock on the instance.nodeId - The ID of the node which is completed.nodeIteration - The iteration of the node which is completed.boolean dropWrittenValuesBackTo(SessionToken session, Instance instance, int nodeId, int nodeIteration, java.lang.String savepoint)
flushing
data from a data container.session - The session which is used to check for access rights on this method and to
retrieve the dropping agent and the corresponding organisational position for logging
purpose.instance - The process instance for which a node is completed. This requires that the
caller of this method has a lock on the instance.nodeId - The ID of the node which is completed.nodeIteration - The iteration of the node which is completed.savepoint - The ID of the savepoint back to which to drop the written data. All savepoints
after this savepoint (and their data) will be removed or rather invalidated. Use
null to invalidate all data that has been written since the last implicit
savepoint of the activity. If there is no implicit savepoint,
all savepoints will be
droppeddropWrittenValues(SessionToken, Instance, int, int)) since the implicit
savepoint was requested but not found.