|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.5.0) E17060-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.runtime.scenario.OdiScenarioVariable
public final class OdiScenarioVariable
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.
Method Summary | |
---|---|
Action |
getAction() Returns Action of this variable (see enum Action ). |
java.lang.Object |
getDefaultValue() Obtain the default value of this variable. |
java.lang.String |
getDescription() Obtains the description of this OdiScenarioVariable . |
java.io.Serializable |
getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used. |
java.lang.String |
getName() Return the name of this variable. |
IRepositoryEntity |
getSecurityContainer() Define a generic way to retrieve container for entities. |
VariableType |
getType() Return the type of this variable entity. |
java.lang.Number |
getVariableOrder() Returns the order of this OdiScenarioVariable . |
boolean |
isReadOnly() Return whether this variable is read-only or not. |
void |
setReadOnly(boolean pReadOnly) |
Methods inherited from class oracle.odi.domain.support.BusinessObject |
---|
clone |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public boolean isReadOnly()
If read-only, this variable's value cannot be changed, and associated scenario will be executed with its default value. Otherwise, this variable value can be changed at runtime when executing an OdiScenario.
public void setReadOnly(boolean pReadOnly)
public VariableType getType()
public java.lang.String getName()
public java.lang.Object getDefaultValue()
When calling that method, the value can be casted into relevant class according this variable's VariableType
.
public Action getAction()
Action
).Action
)public java.lang.String getDescription()
OdiScenarioVariable
.public java.lang.Number getVariableOrder()
OdiScenarioVariable
.OdiScenarioVariable
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.
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.5.0) E17060-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |