Skip navigation links

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.5.0)

E17060-02


oracle.odi.domain.runtime.loadplan
Class OdiLoadPlanStepVariable

java.lang.Object
  extended by oracle.odi.domain.support.BusinessObject
      extended by oracle.odi.domain.support.AbstractRepositoryEntity
          extended by oracle.odi.domain.runtime.loadplan.OdiLoadPlanStepVariable

All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, IRepositoryEntity

public class OdiLoadPlanStepVariable
extends oracle.odi.domain.support.AbstractRepositoryEntity

This class represents the association between an OdiLoadPlanVariable and an OdiLoadPlanStep.

On each step, the user can decide to override an OdiLoadPlanVariable.

The life cycle of an OdiLoadPlanStepVariable begins when the user overrides an OdiLoadPlanVariable on a OdiLoadPlanStep.
The OdiLoadPlanStepVariable is then stored in the runtime repository when the OdiLoadPlanStep is persisted. The users can modify the OdiLoadPlanStepVariable to make it fit their needs.
The life cycle ends in 3 ways
-when the user decides to break the association between the step and the variable (remove the overridden variable)
-when the OdiLoadPlanStep is removed from the OdiLoadPlan
-when the OdiLoadPlanVariable is removed from the OdiLoadPlan

Since:
11.1.1.5.0
See Also:
Serialized Form

Method Summary
 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()
           
 OdiLoadPlanStep getLoadPlanStep()
           
 OdiLoadPlanVariable getLoadPlanVariable()
           
 IRepositoryEntity getSecurityContainer()
          Define a generic way to retrieve container for entities.
 java.lang.Object getValue()
           
 boolean isRefresh()
           
 void setRefresh(boolean refresh)
           
 void setValue(java.lang.Object pValue)
           

 

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

getValue

public java.lang.Object getValue()
Returns:
Variable default value for this step
See Also:
#setDefaultValue(String)

setValue

public void setValue(java.lang.Object pValue)
Parameters:
value - Variable default value for this step
See Also:
#getDefaultValue()

isRefresh

public boolean isRefresh()
Returns:
0/1 Variable Refresh indicator
See Also:
setRefresh(boolean)

setRefresh

public void setRefresh(boolean refresh)
Parameters:
refresh - 0/1 Variable Refresh indicator
See Also:
isRefresh()

getLoadPlan

public OdiLoadPlan getLoadPlan()
Returns:
the load plan in which the OdiLoadPlanVariable is defined.
See Also:
OdiLoadPlan

getLoadPlanStep

public OdiLoadPlanStep getLoadPlanStep()
Returns:
the parent loadPlanStep

getLoadPlanVariable

public OdiLoadPlanVariable getLoadPlanVariable()
Returns:
the parent loadPlanVariable

getSecurityContainer

public IRepositoryEntity getSecurityContainer()
Description copied from interface: IRepositoryEntity
Define a generic way to retrieve container for entities.
Returns:
container entity

Skip navigation links

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.5.0)

E17060-02


Copyright © 2011, Oracle and/or its affiliates. All rights reserved.