Skip navigation links

oracle.odi.domain.runtime.loadplan
Class OdiLoadPlanVariable

java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.runtime.loadplan.OdiLoadPlanVariable

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity

public class OdiLoadPlanVariable

extends oracle.odi.domain.support.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

See Also:

Serialized Form

Method Summary

OdiVariable.DataType	getDataType()
java.lang.String	getDescription()
java.io.Serializable	getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
OdiLoadPlan	getLoadPlan()
OdiLogicalSchema	getLogicalSchema()
java.lang.String	getName()
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
java.lang.String	getSqlText()
java.util.Collection<OdiLoadPlanStepCase>	getStepCaseUsage() Returns the unmodifiable collection of usage of this variable as a test variable for a stepCase.
java.util.Collection<OdiLoadPlanStepVariable>	getVariableOverridenUsages() Returns the unmodifiable collection of usage of this variable as overridden variable.
void	setDataType(OdiVariable.DataType dataType)
void	setDescription(java.lang.String pDescription)

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

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IRepositoryEntity

Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

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.

Returns:

the persistence identity of this instance

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:

java.lang.IllegalArgumentException - 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<OdiLoadPlanStepVariable> getVariableOverridenUsages()

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

getStepCaseUsage

public java.util.Collection<OdiLoadPlanStepCase> getStepCaseUsage()

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

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Returns:

container entity

Skip navigation links