flexagon.fd.core

Class Properties

java.lang.Object

flexagon.ff.common.core.pojos.BasePOJO

flexagon.fd.core.Properties

All Implemented Interfaces:

java.io.Serializable

public class Properties
extends BasePOJO

Represents a collection of properties contained within the WorkflowExecutionContext. Properties are defined within one of two scopes:

• Environment Instance scoped - stored using key of instance code.
• Project scoped - stored using key of the EMPTY_INSTANCE code.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMPTY_INSTANCE

Constructor Summary

Constructors

Constructor and Description
Properties() INTERNAL USE ONLY

Method Summary

Methods

Modifier and Type	Method and Description
void	addInstanceProperty(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Object pValue, PropertyValue.PropertyTypeEnum pDataType, boolean pIsEncrypted, boolean pIsExprssion) INTERNAL USE ONLY
void	addProperty(java.lang.String pKey, java.lang.Object pValue, PropertyValue.PropertyTypeEnum pDataType, boolean pIsEncrypted, boolean pIsExpression) INTERNAL USE ONLY
void	clearUpdates() INTERNAL USE ONLY
java.util.Map<java.lang.String,java.util.Map<java.lang.String,PropertyValue>>	getInstancePropertyMap() Returns a Map of environment instance scoped properties (for all instances).
java.util.Map<java.lang.String,PropertyValue>	getPropertyMap() Returns a Map of project-scoped properties for the current execution
java.lang.Object	getPropertyValue(java.lang.String pKey) Returns a property value for the project-scoped property identified by the given property key.
java.lang.Object	getPropertyValue(java.lang.String pInstanceCode, java.lang.String pKey) Returns a property value for the environment instance scoped property identified by the given instance code and property key.
PropertyValue	getPropertyValueObject(java.lang.String pInstanceCode, java.lang.String pKey) Returns a PropertyValue object for the environment instance scoped property identified by the given instance code and property key.
java.util.Map<java.lang.String,PropertyValue>	getUpdatedPropertyMap() INTERNAL USE ONLY
void	setInstanceProperties(java.util.Map<java.lang.String,java.util.Map<java.lang.String,PropertyValue>> pInstanceProperties) INTERNAL USE ONLY
void	setProperties(java.util.Map<java.lang.String,PropertyValue> pProperties) INTERNAL USE ONLY
void	updateProperty(java.lang.String pKey, java.lang.Object pValue) INTERNAL USE ONLY
void	updateProperty(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Object pValue) INTERNAL USE ONLY
boolean	wasUpdated(java.lang.String pInstanceCode, java.lang.String pKey) INTERNAL USE ONLY

Methods inherited from class flexagon.ff.common.core.pojos.BasePOJO

areEqual, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_INSTANCE

public static final java.lang.String EMPTY_INSTANCE

See Also:

Constant Field Values

Constructor Detail

Properties

public Properties()

INTERNAL USE ONLY

Method Detail

setInstanceProperties

public void setInstanceProperties(java.util.Map<java.lang.String,java.util.Map<java.lang.String,PropertyValue>> pInstanceProperties)

INTERNAL USE ONLY

setProperties

public void setProperties(java.util.Map<java.lang.String,PropertyValue> pProperties)

INTERNAL USE ONLY

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.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 java.lang.Object getPropertyValue(java.lang.String pInstanceCode,
                                java.lang.String pKey)

Returns a property value for the environment instance 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(java.lang.String pInstanceCode,
                                   java.lang.String pKey)

Returns a PropertyValue object for the environment instance 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(java.lang.String pKey,
                  java.lang.Object pValue)
                    throws FlexCheckedException

INTERNAL USE ONLY

Throws:

FlexCheckedException

updateProperty

public void updateProperty(java.lang.String pInstanceCode,
                  java.lang.String pKey,
                  java.lang.Object pValue)
                    throws FlexCheckedException

INTERNAL USE ONLY

Throws:

FlexCheckedException

addProperty

public void addProperty(java.lang.String pKey,
               java.lang.Object pValue,
               PropertyValue.PropertyTypeEnum pDataType,
               boolean pIsEncrypted,
               boolean pIsExpression)

INTERNAL USE ONLY

addInstanceProperty

public void addInstanceProperty(java.lang.String pInstanceCode,
                       java.lang.String pKey,
                       java.lang.Object pValue,
                       PropertyValue.PropertyTypeEnum pDataType,
                       boolean pIsEncrypted,
                       boolean pIsExprssion)

INTERNAL USE ONLY

clearUpdates

public void clearUpdates()

INTERNAL USE ONLY

getUpdatedPropertyMap

public java.util.Map<java.lang.String,PropertyValue> getUpdatedPropertyMap()

INTERNAL USE ONLY

getInstancePropertyMap

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,PropertyValue>> getInstancePropertyMap()

Returns a Map of environment instance scoped properties (for all instances).

Returns:

the environment scoped properties as a Map (keyed by instance)

getPropertyMap

public java.util.Map<java.lang.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(java.lang.String pInstanceCode,
                 java.lang.String pKey)

INTERNAL USE ONLY