public final class OdiScenarioVariable extends AbstractRuntimeVariable implements IExecutableVariable
Defines a variable inside an OdiScenario
and is part of the OdiScenario
-
OdiScenarioVariable
- OdiScenarioSequence
- OdiScenarioReport
aggregate.
An OdiScenarioVariable
is created during scenario generation for each ODI Variable
referenced inside source component of the scenario. Once created, an OdiScenarioVariable
is by default readOnly, meaning it cannot be overriden by a startup parameter when a scenario is executed.
However, this property can be set to false to make it overridable. An OdiScenarioVariable
cannot be removed from the OdiScenario
it belongs and its life cycle ends only when enclosing
OdiScenario
is removed from runtime repository.
External SDK users should use this object for read-only purpose.
Constructor and Description |
---|
OdiScenarioVariable(java.lang.String pName,
VariableType pType)
FOR INTERNAL USE ONLY.
|
Modifier and Type | Method and Description |
---|---|
Action |
getAction()
Deprecated.
As of ODI 11.1.1.5 replaced by
AbstractRuntimeVariable.getValuePersistence() |
java.io.Serializable |
getInternalId()
Provides a common getter for the persistence layer to obtain an identity,
irrespective of the actual type of identity used.
|
OdiScenario |
getScenario()
Returns the
OdiScenario in which this OdiScenarioVariable is defined. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
void |
setDefaultValue(java.lang.Object pDefaultValue)
FOR INTERNAL USE ONLY.
|
void |
setDescription(java.lang.String pDescription)
FOR INTERNAL USE ONLY.
|
void |
setName(java.lang.String pName)
FOR INTERNAL USE ONLY.
|
void |
setReadOnly(boolean pReadOnly)
Specifies whether this variable is read-only (i.e.
|
void |
setType(VariableType pType)
FOR INTERNAL USE ONLY.
|
void |
setValuePersistence(ValuePersistence pValuePersistence)
FOR INTERNAL USE ONLY.
|
void |
setVariableOrder(java.lang.Number pVariableOrder)
FOR INTERNAL USE ONLY.
|
getDefaultValue, getDescription, getName, getType, getValuePersistence, getVariableOrder, isReadOnly
public OdiScenarioVariable(java.lang.String pName, VariableType pType)
Constructs the OdiScenarioVariable
with specified name and data type.
pName
- variable namepType
- variable data typepublic OdiScenario getScenario()
OdiScenario
in which this OdiScenarioVariable
is defined.public void setReadOnly(boolean pReadOnly)
NOTE: Parent OdiScenario
's snapshot number should be bumped up on every modification its
OdiScenarioVariable
. This is done in this method internally. So user should not take care of
this.
pReadOnly
- public Action getAction()
AbstractRuntimeVariable.getValuePersistence()
Action
).Action
)public java.io.Serializable getInternalId()
IRepositoryEntity
Typically a subclass will delegate to a public
SomePrimitiveWrapper getId()
method. The necessity for the
getInternalId()
abstract method is solely because the
persistence layer needs a way of obtaining the identity irrespective of
the actual identity implementation choice.
Returning null
from this method will indicate the object has
never been saved. This will likely be relied on by some DAO
implementations.
getInternalId
in interface IRepositoryEntity
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public void setName(java.lang.String pName)
Sets the name for this OdiScenarioVariable
.
pName
- the namepublic void setType(VariableType pType)
Sets the data type for this OdiScenarioVariable
.
pType
- the data typepublic void setValuePersistence(ValuePersistence pValuePersistence)
Sets the value persistence type for this OdiScenarioVariable
.
pValuePersistence
- the value persistence typepublic void setDescription(java.lang.String pDescription)
Sets the description for this OdiScenarioVariable
.
pDescription
- the descriptionpublic void setVariableOrder(java.lang.Number pVariableOrder)
Sets the order for this OdiScenarioVariable
.
pVariableOrder
- the orderpublic void setDefaultValue(java.lang.Object pDefaultValue)
Sets the default value for this OdiScenarioVariable
.
pDefaultValue
- the default value