Package step.parameter

Class Parameter

java.lang.Object

step.core.accessors.AbstractIdentifiableObject

step.core.accessors.AbstractOrganizableObject

step.core.accessors.AbstractTrackedObject

step.parameter.Parameter

All Implemented Interfaces:

ActivableObject, EnricheableObject

public class Parameter
extends step.core.accessors.AbstractTrackedObject
implements ActivableObject, EnricheableObject

Field Summary

Fields

Modifier and Type	Field	Description
protected Expression	activationExpression
protected java.lang.String	description
protected java.lang.String	encryptedValue	When running with an encryption manager, the value of protected Parameters is encrypted and the encrypted value is stored into this field
static java.lang.String	ENTITY_NAME
protected java.lang.String	key
protected java.lang.Integer	priority
protected java.lang.Boolean	protectedValue
protected ParameterScope	scope
protected java.lang.String	scopeEntity
protected java.lang.String	value

Fields inherited from class step.core.accessors.AbstractTrackedObject

lastModificationDate, lastModificationUser

Fields inherited from class step.core.accessors.AbstractOrganizableObject

attributes, NAME, VERSION

Fields inherited from class step.core.accessors.AbstractIdentifiableObject

customFields, ID

Constructor Summary

Constructors

Constructor	Description
Parameter()
Parameter(Expression activationExpression, java.lang.String key, java.lang.String value, java.lang.String description)

Method Summary

Modifier and Type	Method	Description
Expression	getActivationExpression()
java.lang.String	getDescription()
java.lang.String	getEncryptedValue()
java.lang.String	getKey()
java.lang.Integer	getPriority()
java.lang.Boolean	getProtectedValue()
ParameterScope	getScope()
java.lang.String	getScopeEntity()
java.lang.String	getValue()
void	setActivationExpression(Expression activationExpression)
void	setDescription(java.lang.String description)
void	setEncryptedValue(java.lang.String encryptedValue)
void	setKey(java.lang.String key)
void	setPriority(java.lang.Integer priority)
void	setProtectedValue(java.lang.Boolean protectedValue)
void	setScope(ParameterScope scope)
void	setScopeEntity(java.lang.String scopeEntity)
void	setValue(java.lang.String value)
java.lang.String	toString()

Methods inherited from class step.core.accessors.AbstractTrackedObject

getLastModificationDate, getLastModificationUser, setLastModificationDate, setLastModificationUser

Methods inherited from class step.core.accessors.AbstractOrganizableObject

addAttribute, getAttribute, getAttributes, hasAttribute, setAttributes

Methods inherited from class step.core.accessors.AbstractIdentifiableObject

addCustomField, computeCustomFieldIfAbsent, equals, getCustomField, getCustomField, getCustomFields, getId, hashCode, setCustomFields, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface step.core.objectenricher.EnricheableObject

addAttribute, getAttribute, getAttributes, setAttributes

Field Detail

ENTITY_NAME

public static final java.lang.String ENTITY_NAME

See Also:

Constant Field Values

key

protected java.lang.String key

value

protected java.lang.String value

description

protected java.lang.String description

activationExpression

protected Expression activationExpression

priority

protected java.lang.Integer priority

protectedValue

protected java.lang.Boolean protectedValue

encryptedValue

protected java.lang.String encryptedValue

When running with an encryption manager, the value of protected Parameters is encrypted and the encrypted value is stored into this field

scope

protected ParameterScope scope

scopeEntity

protected java.lang.String scopeEntity

Constructor Detail

Parameter

public Parameter()

Parameter

public Parameter(Expression activationExpression,
                 java.lang.String key,
                 java.lang.String value,
                 java.lang.String description)

Method Detail

getKey

public java.lang.String getKey()

setKey

public void setKey(java.lang.String key)

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)

getActivationExpression

public Expression getActivationExpression()

Specified by:

getActivationExpression in interface ActivableObject

getPriority

public java.lang.Integer getPriority()

Specified by:

getPriority in interface ActivableObject

setActivationExpression

public void setActivationExpression(Expression activationExpression)

setPriority

public void setPriority(java.lang.Integer priority)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getProtectedValue

public java.lang.Boolean getProtectedValue()

setProtectedValue

public void setProtectedValue(java.lang.Boolean protectedValue)

getEncryptedValue

public java.lang.String getEncryptedValue()

setEncryptedValue

public void setEncryptedValue(java.lang.String encryptedValue)

getScope

public ParameterScope getScope()

Returns:

the ParameterScope of this parameter

setScope

public void setScope(ParameterScope scope)

getScopeEntity

public java.lang.String getScopeEntity()

Returns:

the name of the entity this parameter is restricted to. For instance: if the scope of a Parameter is set to FUNCTION, the scopeEntity represent the name of the Function for which this parameter applies

setScopeEntity

public void setScopeEntity(java.lang.String scopeEntity)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object