Package flexagon.fd.core

Class Properties

java.lang.Object
flexagon.ff.common.core.pojos.BasePOJO
flexagon.fd.core.Properties
All Implemented Interfaces:
Serializable
public class Properties extends BasePOJO
Represents a collection of properties contained within the WorkflowExecutionContext. Properties are defined within one of two scopes:

  • Target scoped - stored using key of instance code.
  • Project scoped - stored using key of the EMPTY_INSTANCE code.
See Also:

  • Field Details

  • Constructor Details

    • Properties

      public Properties()
      INTERNAL USE ONLY

  • Method Details

    • toString

      public String toString()
      Description copied from class: BasePOJO
      Returns custom String representation implemented by walking complete object structure.
      Overrides:
      toString in class BasePOJO
      Returns:
      a String representation of this object

    • setInstanceProperties

      public void setInstanceProperties(Map<String,Map<String,PropertyValue>> pInstanceProperties)
      INTERNAL USE ONLY

    • setProperties

      public void setProperties(Map<String,PropertyValue> pProperties)
      INTERNAL USE ONLY

    • getPropertyValue

      public Object getPropertyValue(String pKey)
      Returns a property value for the project-scoped property identified by the given property key. The value must be cast to the documented type.
      Parameters:
      pKey - the key of the project-scoped property
      Returns:
      the property value for the given key

    • getPropertyValue

      public Object getPropertyValue(String pInstanceCode, String pKey)
      Returns a property value for the Target scoped property identified by the given instance code and property key. The value must be cast to the documented type.
      Parameters:
      pInstanceCode - the instance code
      pKey - the property key
      Returns:
      the property value for the given instance code and property key

    • getPropertyValueObject

      public PropertyValue getPropertyValueObject(String pInstanceCode, String pKey)
      Returns a PropertyValue object for the Target scoped property identified by the given instance code and property key.
      Parameters:
      pInstanceCode - the instance code
      pKey - the property key
      Returns:
      the property value object for the given instance code and property key

    • updateProperty

      public void updateProperty(String pKey, Object pValue) throws FlexCheckedException
      INTERNAL USE ONLY
      Throws:
      FlexCheckedException

    • updateProperty

      public void updateProperty(String pInstanceCode, String pKey, Object pValue) throws FlexCheckedException
      INTERNAL USE ONLY
      Throws:
      FlexCheckedException

    • addProperty

      public void addProperty(String pKey, Object pValue, DataTypeEnum pDataType, boolean pIsEncrypted, boolean pIsExpression)
      INTERNAL USE ONLY

    • addProperty

      public void addProperty(String pKey, PropertyValue pProperty)
      INTERNAL USE ONLY

    • addStringProperty

      public void addStringProperty(String pKey, String pValue)
      INTERNAL USE ONLY

    • addDoubleProperty

      public void addDoubleProperty(String pKey, Double pValue)
      INTERNAL USE ONLY

    • addIntegerProperty

      public void addIntegerProperty(String pKey, Integer pValue)
      INTERNAL USE ONLY

    • addBooleanProperty

      public void addBooleanProperty(String pKey, Boolean pValue)
      INTERNAL USE ONLY

    • addInstanceProperty

      public void addInstanceProperty(String pInstanceCode, String pKey, Object pValue, DataTypeEnum pDataType, boolean pIsEncrypted, boolean pIsExpression)
      INTERNAL USE ONLY

    • addInstanceProperty

      public void addInstanceProperty(String pInstanceCode, String pKey, PropertyValue pProperty)

    • clearUpdates

      public void clearUpdates()
      INTERNAL USE ONLY

    • getUpdatedPropertyMap

      public Map<String,PropertyValue> getUpdatedPropertyMap()
      INTERNAL USE ONLY

    • getInstancePropertyMap

      public Map<String,Map<String,PropertyValue>> getInstancePropertyMap()
      Returns a Map of Target scoped properties (for all instances).
      Returns:
      the environment scoped properties as a Map (keyed by instance)

    • getPropertyMap

      public Map<String,PropertyValue> getPropertyMap()
      Returns a Map of project-scoped properties for the current execution
      Returns:
      the project-scoped properties as a Map

    • wasUpdated

      public boolean wasUpdated(String pInstanceCode, String pKey)
      INTERNAL USE ONLY