oracle.odi.domain.project
Class StepVariable

java.lang.Object
  oracle.odi.domain.support.BusinessObject
      oracle.odi.domain.support.AbstractRepositoryEntity
          oracle.odi.domain.project.Step
              oracle.odi.domain.project.StepVariable

All Implemented Interfaces:

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

public class StepVariable
extends Step

Subclass of Step that will be used inside an OdiPackage to express usage/action of a variable for further use inside that OdiPackage.

Such step will be used to

• declare a variable into an OdiPackage for further action on it
• set a variable value
• refresh a variable
• evaluate a variable

and such actions will be defined using one of the provided StepVariable.IVariableAction implementation that are respectively StepVariable.DeclareVariable, StepVariable.SetVariable, StepVariable.RefreshVariable and StepVariable.EvaluateVariable.

Since:

11.1.1.3.0

See Also:

Serialized Form

Nested Class Summary

static class	StepVariable.DeclareVariable Implements declare action for an StepVariable.
static class	StepVariable.EvaluateVariable Implements evaluate action for an StepVariable.
static interface	StepVariable.IVariableAction Type safety interface that implementation classes will use to define variable actions.
static class	StepVariable.RefreshVariable Implements refresh action for an StepVariable.
static class	StepVariable.SetVariable Implements set action for an StepVariable.

Nested classes/interfaces inherited from class oracle.odi.domain.project.Step

Step.LogLevel

Field Summary

Fields inherited from class oracle.odi.domain.project.Step

NAME_MAX_LENGTH

Constructor Summary

StepVariable(OdiPackage pPackage, OdiVariable pVariable, java.lang.String pName)
Constructor that sets the parent OdiPackage, the OdiVariable upon which this Step is based and the step name.

Method Summary

StepVariable.IVariableAction	getAction() Returns the action proceeded by this step.
OdiVariable	getVariable() Returns the variable used by this step.
void	setAction(StepVariable.IVariableAction pVariableAction) Defines the action to do with this variable.

Methods inherited from class oracle.odi.domain.project.Step

getFailureRetryDelay, getFailureRetryNumber, getInternalId, getLoglevel, getName, getNextStepAfterFailure, getNextStepAfterSuccess, getParentPackage, getSecurityContainer, getStepId, isFirstStep, setFailureRetryDelay, setFailureRetryNumber, setLoglevel, setName, setNextStepAfterFailure, setNextStepAfterSuccess

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

Constructor Detail

StepVariable

public StepVariable(OdiPackage pPackage,
                    OdiVariable pVariable,
                    java.lang.String pName)

Constructor that sets the parent OdiPackage, the OdiVariable upon which this Step is based and the step name.

Parameters:

pPackage - the package that will hold this step

pName - the name of the step to be created

pVariable - the variable this step upon which this step is based

Throws:

java.lang.IllegalArgumentException - if the package is null, if the variable is null or from another project or if the name is null, empty or longer than

Method Detail

getAction

public StepVariable.IVariableAction getAction()

Returns the action proceeded by this step.

Returns:

a StepVariable.IVariableAction object

See Also:

setAction(IVariableAction)

getVariable

public OdiVariable getVariable()

Returns the variable used by this step.

Returns:

this step's OdiVariable

setAction

public void setAction(StepVariable.IVariableAction pVariableAction)

Defines the action to do with this variable.

Parameters:

pVariableAction - the action

See Also:

getAction()