Package com.flowable.dataobject.api.runtime

Interface DataObjectInstanceVariableContainer

All Superinterfaces:
org.flowable.common.engine.api.variable.VariableContainer
All Known Implementing Classes:
DataObjectInstanceVariableContainerImpl
public interface DataObjectInstanceVariableContainer
extends org.flowable.common.engine.api.variable.VariableContainer
A data object instance variable container.
Author:
Filip Hrisafov

  • Method Summary

    Modifier and Type Method Description
    default java.lang.Boolean getBoolean​(java.lang.String property)  
    default java.util.Date getDate​(java.lang.String property)  
    java.lang.String getDefinitionId()
    Returns the id of the master data definition this instance belongs to.
    java.lang.String getDefinitionKey()
    Returns the key of the master data definition this instance belongs to.
    default java.lang.Double getDouble​(java.lang.String property)  
    java.lang.Object getId()  
    default java.lang.Integer getInteger​(java.lang.String property)  
    default java.lang.Long getLong​(java.lang.String property)  
    java.lang.Object getLookupId()
    Returns the lookup id of this data object instance, which needs to be unique only within the same data object definition and source.
    default java.lang.String getString​(java.lang.String property)  
    java.lang.String getTenantId()
    The tenant id of the definition
    <T> T getValue​(java.lang.String property, java.lang.Class<T> valueType)
    Get a value for the given property with the give valueType
    default java.lang.Object getVariable​(java.lang.String variableName)  
    boolean hasValue​(java.lang.String property)
    Check whether the data object instance has the given property
    default boolean hasVariable​(java.lang.String variableName)  
    java.lang.Iterable<java.lang.String> propertyNames()
    An iterable of all the names of the properties for this data object instance.
    default java.lang.Object removeValue​(java.lang.String property)  
    <T> T removeValue​(java.lang.String property, java.lang.Class<T> propertyClass)  
    void setId​(java.lang.Object id)  
    <T> void setValue​(java.lang.String property, T value)  
    default void setVariable​(java.lang.String variableName, java.lang.Object variableValue)  

    Methods inherited from interface org.flowable.common.engine.api.variable.VariableContainer

    setTransientVariable

  • Method Details

    • getId

      java.lang.Object getId()

    • setId

      void setId​(java.lang.Object id)

    • getLookupId

      java.lang.Object getLookupId()
      Returns the lookup id of this data object instance, which needs to be unique only within the same data object definition and source.
      Returns:
      the lookup id of this data object, as given and used by the data source managing this data object instance

    • getDefinitionId

      java.lang.String getDefinitionId()
      Returns the id of the master data definition this instance belongs to.
      Returns:
      the id of the master data definition

    • getDefinitionKey

      java.lang.String getDefinitionKey()
      Returns the key of the master data definition this instance belongs to.
      Returns:
      the key of the master data definition

    • getString

      default java.lang.String getString​(java.lang.String property)

    • getBoolean

      default java.lang.Boolean getBoolean​(java.lang.String property)

    • getInteger

      default java.lang.Integer getInteger​(java.lang.String property)

    • getLong

      default java.lang.Long getLong​(java.lang.String property)

    • getDouble

      default java.lang.Double getDouble​(java.lang.String property)

    • getDate

      default java.util.Date getDate​(java.lang.String property)

    • getValue

      <T> T getValue​(java.lang.String property, java.lang.Class<T> valueType)
      Get a value for the given property with the give valueType
      Type Parameters:
      T - the type of the value
      Parameters:
      property - the name of the property
      valueType - the type of the value
      Returns:
      the value for the given property

    • hasValue

      boolean hasValue​(java.lang.String property)
      Check whether the data object instance has the given property
      Parameters:
      property - the name of the property
      Returns:
      true if this data object instance has a property with given name, false otherwise

    • hasVariable

      default boolean hasVariable​(java.lang.String variableName)
      Specified by:
      hasVariable in interface org.flowable.common.engine.api.variable.VariableContainer

    • getVariable

      default java.lang.Object getVariable​(java.lang.String variableName)
      Specified by:
      getVariable in interface org.flowable.common.engine.api.variable.VariableContainer

    • setValue

      <T> void setValue​(java.lang.String property, T value)

    • removeValue

      default java.lang.Object removeValue​(java.lang.String property)

    • removeValue

      <T> T removeValue​(java.lang.String property, java.lang.Class<T> propertyClass)

    • setVariable

      default void setVariable​(java.lang.String variableName, java.lang.Object variableValue)
      Specified by:
      setVariable in interface org.flowable.common.engine.api.variable.VariableContainer

    • getTenantId

      java.lang.String getTenantId()
      The tenant id of the definition
      Specified by:
      getTenantId in interface org.flowable.common.engine.api.variable.VariableContainer
      Returns:
      the tenant id of the definition

    • propertyNames

      java.lang.Iterable<java.lang.String> propertyNames()
      An iterable of all the names of the properties for this data object instance.
      Returns:
      iterator of the properties