oracle.odi.domain.runtime.loadplan

Class OdiLoadPlanVariable

java.lang.Object

AbstractRepositoryEntity

oracle.odi.domain.runtime.loadplan.OdiLoadPlanVariable

public class OdiLoadPlanVariable
extends AbstractRepositoryEntity

The OdiLoadPlanVariable is the inclusion of an OdiVariable in the context of an OdiLoadPlan.

OdiLoadPlan manages a list of OdiLoadPlanVariable that can be overridden on every step and used for OdiLoadPlanStepCase.
The sql text of an OdiLoadPlanVariable is the result of the code generation of the OdiVariable sql text.
The properties of an OdiLoadPlanVariable are not editable.

The life cycle of an OdiLoadPlanVariable begins when the user associates an OdiVariable with the OdiLoadPlan, thus creating an OdiLoadPlanVariable.
Then the OdiLoadPlanVariable is managed by the OdiLoadPlan.
The life cycle ends when the OdiLoadPlanVariable is removed from the OdiLoadPlan.

Since:

11.1.1.5.0

Method Summary

Modifier and Type	Method and Description
OdiVariable.DataType	getDataType()
java.lang.String	getDescription()
java.io.Serializable	getInternalId()
OdiLoadPlan	getLoadPlan()
OdiLogicalSchema	getLogicalSchema()
java.lang.String	getName()
IRepositoryEntity	getSecurityContainer()
java.lang.String	getSqlText()
java.util.Collection	getStepCaseUsage() Returns the unmodifiable collection of usage of this variable as a test variable for a stepCase.
java.util.Collection	getVariableOverridenUsages() Returns the unmodifiable collection of usage of this variable as overridden variable.
void	setDataType(OdiVariable.DataType dataType)
void	setDescription(java.lang.String pDescription)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getInternalId

public java.io.Serializable getInternalId()

getLoadPlan

public OdiLoadPlan getLoadPlan()

Returns:

the load plan in which the OdiLoadPlanVariable is defined.

See Also:

OdiLoadPlan

getName

public java.lang.String getName()

Returns:

the Qualified Variable Name (PROJECT.VAR_NAME)

getDescription

public java.lang.String getDescription()

Returns:

the description of the variable

setDescription

public void setDescription(java.lang.String pDescription)

getDataType

public OdiVariable.DataType getDataType()

Returns:

the data type of the variable

setDataType

public void setDataType(OdiVariable.DataType dataType)

Parameters:

dataType - must not be null

Throws:

DomainRuntimeException - if the datatype is null.

getLogicalSchema

public OdiLogicalSchema getLogicalSchema()

Returns:

the logical schema name that defines where the SQL query of this variable will be executed

See Also:

OdiLogicalSchema

getSqlText

public java.lang.String getSqlText()

Returns:

Text pointer to the SQL query used by this variable. At this point it's already generated for runtime

getVariableOverridenUsages

public java.util.Collection getVariableOverridenUsages()

Returns the unmodifiable collection of usage of this variable as overridden variable.

getStepCaseUsage

public java.util.Collection getStepCaseUsage()

Returns the unmodifiable collection of usage of this variable as a test variable for a stepCase.

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

toString

public java.lang.String toString()