public interface DataContext extends InputDataContext
InvalidExecutorThreadException will be thrown
if the method is not called by the main thread of the corresponding
component.
This data context may be read-only in which case all
store-methods throw an UnsupportedOperationException. A
read-only context is used for
displaying purpose.
| Modifier and Type | Method and Description |
|---|---|
boolean |
ignoredValue(java.lang.String parameterName)
Returns whether the value of the designated output parameter is not or has
not been set (ignored) by the application.
|
void |
ignoreValue(java.lang.String parameterName)
Ignores the value of the designated parameter that is the value has not
been written.
|
boolean |
isReadOnly()
Returns whether this data container is read only and therefore does not
allow to store values (and throws an
UnsupportedOperationException at the corresponding methods). |
void |
storeBooleanParameterValue(java.lang.String parameterName,
boolean value)
Writes an output parameter of the type boolean to the data container of the
process management system.
|
void |
storeDateParameterValue(java.lang.String parameterName,
java.util.Date value)
Writes an output parameter of the type date to the data context of the
process management system.
|
boolean |
storedBooleanParameterValue(java.lang.String parameterName)
Reads the boolean value of the designated output parameter.
|
java.util.Date |
storedDateParameterValue(java.lang.String parameterName)
Reads the date value of the designated output parameter.
|
double |
storedFloatParameterValue(java.lang.String parameterName)
Reads the double value of the designated output parameter.
|
long |
storedIntegerParameterValue(java.lang.String parameterName)
Reads the long value of the designated output parameter.
|
java.lang.String |
storedStringParameterValue(java.lang.String parameterName)
Reads the string value of the designated output parameter.
|
UDTValue |
storedUDTParameterValue(java.lang.String parameterName)
Reads the value of the designated output parameter of user-defined type.
|
java.net.URI |
storedURIParameterValue(java.lang.String parameterName)
Reads the URI value of the designated output parameter.
|
void |
storeFloatParameterValue(java.lang.String parameterName,
double value)
Writes an output parameter of the type float to the data container of the
process management system.
|
void |
storeIntegerParameterValue(java.lang.String parameterName,
long value)
Writes an output parameter of the type integer (in java: long) to the data
context of the process management system.
|
void |
storeStringParameterValue(java.lang.String parameterName,
java.lang.String value)
Writes an output parameter of type String to the data container of the
process management system.
|
void |
storeUDTParameterValue(java.lang.String parameterName,
UDTValue value)
Writes an output parameter of an user defined type to the data container of
the process management system.
|
void |
storeURIParameterValue(java.lang.String parameterName,
java.net.URI value)
Writes an output parameter of type URI to the data container of the process
management system.
|
isNull, retrieveBooleanParameterValue, retrieveDateParameterValue, retrieveFloatParameterValue, retrieveIntegerParameterValue, retrieveStringParameterValue, retrieveUDTParameterValue, retrieveURIParameterValuegetUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValuegetPluginData, getPluginDatas, getSupportedPluginsboolean isReadOnly()
UnsupportedOperationException at the corresponding methods).void ignoreValue(java.lang.String parameterName)
throws NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the parameter to be ignored.NoSuchParameterException - If the parameter of the designated name
does not exist, a NoSuchParameterException will be
thrown.java.lang.UnsupportedOperationException - If this data context is only for
displaying purpose,
an UnsupportedOperationException will be thrown.boolean ignoredValue(java.lang.String parameterName)
throws NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to check for being
unset.true if the value of the designated output parameter
is or has not been written.NoSuchParameterException - If the output parameter of the designated
name does not exist, a NoSuchParameterException
will be thrown.void storeIntegerParameterValue(java.lang.String parameterName,
long value)
throws InvalidDataTypeException,
NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be written.value - The value that is written for the designated output parameter.InvalidDataTypeException - If the designated parameter is not of type
INTEGER, an InvalidDataTypeException will be
raised.NoSuchParameterException - If the parameter of the designated name
does not exist, a NoSuchParameterException will be
thrown.java.lang.UnsupportedOperationException - If this data context is only for
displaying purpose,
an UnsupportedOperationException will be thrown.DataContainerlong storedIntegerParameterValue(java.lang.String parameterName)
throws InvalidDataTypeException,
NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be read.long.InvalidDataTypeException - If the designated output parameter is not
of type INTEGER, an InvalidDataTypeException will
be raised.NoSuchParameterException - If the output parameter of the designated
name does not exist, a NoSuchParameterException
will be thrown.ProcessConstants.AdeptDataType.INTEGERvoid storeFloatParameterValue(java.lang.String parameterName,
double value)
throws InvalidDataTypeException,
NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be written.value - The value that is written for the designated output parameter.InvalidDataTypeException - If the designated 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.java.lang.UnsupportedOperationException - If this data context is only for
displaying purpose,
an UnsupportedOperationException will be thrown.DataContainerdouble storedFloatParameterValue(java.lang.String parameterName)
throws InvalidDataTypeException,
NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be read.double.InvalidDataTypeException - If the designated output parameter is not
of type FLOAT, an InvalidDataTypeException will be
raised.NoSuchParameterException - If the output parameter of the designated
name does not exist, a NoSuchParameterException
will be thrown.ProcessConstants.AdeptDataType.FLOATvoid storeBooleanParameterValue(java.lang.String parameterName,
boolean value)
throws InvalidDataTypeException,
NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be written.value - The value that is written for the designated output parameter.InvalidDataTypeException - If the designated parameter is not of type
BOOLEAN, an InvalidDataTypeException will be
raised.NoSuchParameterException - If the parameter of the designated name
does not exist, a NoSuchParameterException will be
thrown.java.lang.UnsupportedOperationException - If this data context is only for
displaying purpose,
an UnsupportedOperationException will be thrown.DataContainerboolean storedBooleanParameterValue(java.lang.String parameterName)
throws InvalidDataTypeException,
NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be read.boolean.InvalidDataTypeException - If the designated output parameter is not
of type BOOLEAN, an InvalidDataTypeException will
be raised.NoSuchParameterException - If the output parameter of the designated
name does not exist, a NoSuchParameterException
will be thrown.ProcessConstants.AdeptDataType.BOOLEANvoid storeStringParameterValue(java.lang.String parameterName,
java.lang.String value)
throws InvalidDataTypeException,
NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be written.value - The value that is written for the designated output parameter.InvalidDataTypeException - If the designated parameter is not of type
STRING, an InvalidDataTypeException will be
raised.NoSuchParameterException - If the parameter of the designated name
does not exist, a NoSuchParameterException will be
thrown.java.lang.UnsupportedOperationException - If this data context is only for
displaying purpose,
an UnsupportedOperationException will be thrown.DataContainerjava.lang.String storedStringParameterValue(java.lang.String parameterName)
throws InvalidDataTypeException,
NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be read.String.InvalidDataTypeException - If the designated output parameter is not
of type STRING, an InvalidDataTypeException will
be raised.NoSuchParameterException - If the output parameter of the designated
name does not exist, a NoSuchParameterException
will be thrown.ProcessConstants.AdeptDataType.STRINGvoid storeDateParameterValue(java.lang.String parameterName,
java.util.Date value)
throws InvalidDataTypeException,
NoSuchParameterException
InvalidExecutorThreadException will be thrown if the method
is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be written.value - The value that is written for the designated output parameter.InvalidDataTypeException - If the designated parameter is not of type
DATE, an InvalidDataTypeException will be raised.NoSuchParameterException - If the parameter of the designated name
does not exist, a NoSuchParameterException will be
thrown.java.lang.UnsupportedOperationException - If this data context is only for
displaying purpose, an
UnsupportedOperationException will be thrown.DataContainerjava.util.Date storedDateParameterValue(java.lang.String parameterName)
throws InvalidDataTypeException,
NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be read.java.util.Date.InvalidDataTypeException - If the designated output parameter is not
of type DATE, an InvalidDataTypeException will
be raised.NoSuchParameterException - If the output parameter of the designated
name does not exist, a NoSuchParameterException
will be thrown.ProcessConstants.AdeptDataType.DATEvoid storeURIParameterValue(java.lang.String parameterName,
java.net.URI value)
throws InvalidDataTypeException,
NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be written.value - The value that is written for the designated output parameter.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.java.lang.UnsupportedOperationException - If this data context is only for
displaying purpose,
an UnsupportedOperationException will be thrown.DataContainerjava.net.URI storedURIParameterValue(java.lang.String parameterName)
throws InvalidDataTypeException,
NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be read.java.net.URI.InvalidDataTypeException - If the output designated parameter is not
of type URI, an InvalidDataTypeException will be
raised.NoSuchParameterException - If the output parameter of the designated
name does not exist, a NoSuchParameterException
will be thrown.ProcessConstants.AdeptDataType.URIvoid storeUDTParameterValue(java.lang.String parameterName,
UDTValue value)
throws InvalidDataTypeException,
NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be written.value - The value that is written for the designated output parameter.InvalidDataTypeException - If the designated parameter is not of type
UDT, an InvalidDataTypeException will be raised.NoSuchParameterException - If the parameter of the designated name
does not exist, a NoSuchParameterException will be
thrown.java.lang.UnsupportedOperationException - If this data context is only for
displaying purpose,
an UnsupportedOperationException will be thrown.DataContainerUDTValue storedUDTParameterValue(java.lang.String parameterName) throws InvalidDataTypeException, NoSuchParameterException
InvalidExecutorThreadException will be thrown if the
method is not called by the main thread of the corresponding component.parameterName - The name of the output parameter to be read.UDTValue.InvalidDataTypeException - If the designated output parameter is not
of type USERDEFINED, an InvalidDataTypeException
will be raised.NoSuchParameterException - If the output parameter of the designated
name does not exist, a NoSuchParameterException
will be thrown.ProcessConstants.AdeptDataType.USERDEFINED