de.aristaflow.adept2.model.datamanagement

Interface ArchiveDataContainer

All Superinterfaces:

UserAttributeContainer

public interface ArchiveDataContainer
extends UserAttributeContainer

This class represents a data container (usually an instance data container) to be archived. Archiving takes place together with the corresponding instance. Note that only instances that have not terminated successfully will have an instance data container to be archived. The data containers of all other instances will be deleted after the instance has terminated.
This interface also allows for serialisation of data containers. However, one may need the right implementation for serialising and deserialising since they may have specific features, for instance parameter values that are written through to the data manager.

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getIgnoredOutputParameters() Gets the names of all output parameters that have not been stored to the data container yet.
java.util.Map<java.lang.String,ProcessConstants.AdeptDataType>	getInputParameterTypes() Gets the types of all input parameters indexed by the parameter name.
java.util.Map<java.lang.String,java.io.Serializable>	getInputParameterValues() Gets the values of all input parameters indexed by the parameter name.
java.util.Collection<java.lang.String>	getNullInputParameters() Gets the names of all input parameters that are NULL.
java.util.Map<java.lang.String,ProcessConstants.AdeptDataType>	getOutputParameterTypes() Gets the types of all output parameters indexed by the parameter name.
java.util.Map<java.lang.String,java.io.Serializable>	getOutputParameterValues() Gets the values of all output parameters that have been stored to the data container indexed by the parameter name.

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

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

Method Detail

getInputParameterTypes

java.util.Map<java.lang.String,ProcessConstants.AdeptDataType> getInputParameterTypes()

Gets the types of all input parameters indexed by the parameter name.

Returns:

The types of all input parameters indexed by the parameter name.

getNullInputParameters

java.util.Collection<java.lang.String> getNullInputParameters()

Gets the names of all input parameters that are NULL.

Returns:

The names of all input parameters that are NULL.

getInputParameterValues

java.util.Map<java.lang.String,java.io.Serializable> getInputParameterValues()

Gets the values of all input parameters indexed by the parameter name.

Returns:

The values of all input parameters indexed by the parameter name.

getOutputParameterTypes

java.util.Map<java.lang.String,ProcessConstants.AdeptDataType> getOutputParameterTypes()

Gets the types of all output parameters indexed by the parameter name.

Returns:

The types of all output parameters indexed by the parameter name.

getIgnoredOutputParameters

java.util.Collection<java.lang.String> getIgnoredOutputParameters()

Gets the names of all output parameters that have not been stored to the data container yet. These have are NULL.

Returns:

The names of all output parameters that have not been stored to the data container yet.

getOutputParameterValues

java.util.Map<java.lang.String,java.io.Serializable> getOutputParameterValues()

Gets the values of all output parameters that have been stored to the data container indexed by the parameter name.

Returns:

The values of all output parameters that have been stored to the data container indexed by the parameter name.