Interface ArchiveDataContainer

  • All Superinterfaces:
    AutoCloseable, Closeable, UserAttributeContainer

    public interface ArchiveDataContainer
    extends UserAttributeContainer, Closeable
    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.
    • Method Detail

      • getInputParameterTypes

        Map<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

        Collection<String> getNullInputParameters()
        Gets the names of all input parameters that are NULL.
        Returns:
        The names of all input parameters that are NULL.
      • getInputParameterValues

        Map<String,​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. The values will be coupled to this ArchiveDataContainer, so do not close them; clone them if required longer than this ArchiveDataContainer.
      • getOutputParameterTypes

        Map<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

        Collection<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

        Map<String,​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. The values will be coupled to this ArchiveDataContainer, so do not close them; clone them if required longer than this ArchiveDataContainer.