oracle.odi.domain.runtime.scenario

Class OdiScenarioVariable

java.lang.Object

AbstractRepositoryEntity

oracle.odi.domain.runtime.common.AbstractRuntimeVariable

oracle.odi.domain.runtime.scenario.OdiScenarioVariable

All Implemented Interfaces:

IExecutableVariable

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.

Since:

11.1.1.3.0

Constructor Summary

Constructors

Constructor and Description
OdiScenarioVariable(java.lang.String pName, VariableType pType) FOR INTERNAL USE ONLY.

Method Summary

Modifier and Type	Method and Description
Action	getAction() Deprecated. As of ODI 11.1.1.5 replaced by AbstractRuntimeVariable.getValuePersistence()
java.io.Serializable	getInternalId()
OdiScenario	getScenario() Returns the OdiScenario in which this OdiScenarioVariable is defined.
IRepositoryEntity	getSecurityContainer()
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.

Methods inherited from class oracle.odi.domain.runtime.common.AbstractRuntimeVariable

getDefaultValue, getDescription, getName, getType, getValuePersistence, getVariableOrder, isReadOnly

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OdiScenarioVariable

public OdiScenarioVariable(java.lang.String pName,
                           VariableType pType)

FOR INTERNAL USE ONLY.

Constructs the OdiScenarioVariable with specified name and data type.

Parameters:

pName - variable name

pType - variable data type

Method Detail

getScenario

public OdiScenario getScenario()

Returns the OdiScenario in which this OdiScenarioVariable is defined.

Returns:

the scenario

setReadOnly

public void setReadOnly(boolean pReadOnly)

Specifies whether this variable is read-only (i.e. not a startup parameter).

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.

Parameters:

pReadOnly -

getAction

public Action getAction()

Deprecated. As of ODI 11.1.1.5 replaced by AbstractRuntimeVariable.getValuePersistence()

Returns Action of this variable (see enum Action).

Returns:

Action of this variable (see enum Action)

getInternalId

public java.io.Serializable getInternalId()

Returns:

the composite key (SCEN_NO, VAR_NAME)

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

setName

public void setName(java.lang.String pName)

FOR INTERNAL USE ONLY.

Sets the name for this OdiScenarioVariable.

Parameters:

pName - the name

setType

public void setType(VariableType pType)

FOR INTERNAL USE ONLY.

Sets the data type for this OdiScenarioVariable.

Parameters:

pType - the data type

setValuePersistence

public void setValuePersistence(ValuePersistence pValuePersistence)

FOR INTERNAL USE ONLY.

Sets the value persistence type for this OdiScenarioVariable.

Parameters:

pValuePersistence - the value persistence type

setDescription

public void setDescription(java.lang.String pDescription)

FOR INTERNAL USE ONLY.

Sets the description for this OdiScenarioVariable.

Parameters:

pDescription - the description

setVariableOrder

public void setVariableOrder(java.lang.Number pVariableOrder)

FOR INTERNAL USE ONLY.

Sets the order for this OdiScenarioVariable.

Parameters:

pVariableOrder - the order

setDefaultValue

public void setDefaultValue(java.lang.Object pDefaultValue)

FOR INTERNAL USE ONLY.

Sets the default value for this OdiScenarioVariable.

Parameters:

pDefaultValue - the default value