Package com.flowable.dataobject.api.runtime

Interface DataObjectHandlingContext

public interface DataObjectHandlingContext
The data object context is used during data object creation and modification operations and is used to provide additional context information like the form model where the operation is based on or additional payload data.
Author:
Micha Kiener

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Object>
    getDataObjectPayload()
    Returns the payload behind the data object being handled in a generic way.
    Map<String,Object>
    getFullFormPayload()
    Returns the full payload behind the form, where the data object is just a part of.
    Map<String,Object>
    getOriginalDataObjectPayload()
    If the current operation is a modification rather than a creation, this method returns the last, original data object data before the update took place.
    Map<String,Object>
    getOriginalFullFormPayload()
    If the current operation is a modification rather than a creation, this method returns the last, original full data object behind the form for data comparison or delta building.

  • Method Details

    • getDataObjectPayload

      Map<String,Object> getDataObjectPayload()
      Returns the payload behind the data object being handled in a generic way.
      Returns:
      the data payload behind the data object

    • getOriginalDataObjectPayload

      Map<String,Object> getOriginalDataObjectPayload()
      If the current operation is a modification rather than a creation, this method returns the last, original data object data before the update took place. It might be used for comparison, to build the delta, etc.
      Returns:
      the optional, original data object payload, might be null, if the current operation is creation of a new object

    • getFullFormPayload

      Map<String,Object> getFullFormPayload()
      Returns the full payload behind the form, where the data object is just a part of. Some additional data might be helpful in order to modify or create the data object.
      Returns:
      the full payload behind the form, not just the payload of the data object

    • getOriginalFullFormPayload

      Map<String,Object> getOriginalFullFormPayload()
      If the current operation is a modification rather than a creation, this method returns the last, original full data object behind the form for data comparison or delta building.
      Returns:
      the optional, original full data payload, might be null, if the current operation is creation of a new object