OdiLoadPlanStep (Oracle Fusion Middleware Java API Reference for Oracle Data Integrator)

java.lang.Object
- oracle.odi.domain.support.BusinessObject
- - oracle.odi.domain.support.AbstractRepositoryEntity
  - - oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement
    - - oracle.odi.domain.runtime.loadplan.OdiLoadPlanStep

All Implemented Interfaces:

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

Direct Known Subclasses:

OdiLoadPlanStepCase, OdiLoadPlanStepContainer, OdiLoadPlanStepRunScenario
```
public abstract class OdiLoadPlanStep
extends OdiLoadPlanElement
```
The OdiLoadPlanStep is an abstract class for the steps of the aggregate OdiLoadPlan.
The implementations are:
The implementations have different behavior in regards to the OdiLoadPlan, this class helps share the common behavior and properties

The life cycle of an OdiLoadPlanStep begins when a user adds one of its implementation to the list of the steps of the OdiLoadPlan.
Users can modify the steps in order to make them fit their needs.
The life cycle ends when the step is removed from the list of steps of the OdiLoadPlan

Order is managed at creation time. When moving, order is managed by the step container. Order is then managed when removing a child.
Since:

11.1.1.5.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`OdiLoadPlanStep.ExceptionBehavior` Behavior in case the `OdiLoadPlanStep` execution throws an exception.
`static class`	`OdiLoadPlanStep.RegenerationMode` Defines the regeneration modes of a step

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MAX_PRIORITY` maximal value for property Priority
`static int`	`MIN_PRIORITY` minimal value for property Priority
`static int`	`SESSION_KEYWORDS_MAX_LENGTH` Maximum length for session keywords strings

Fields inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement
NAME_MAX_LENGTH

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`OdiLoadPlanStepVariable`	`addVariable(OdiLoadPlanVariable pOdiLoadPlanVariable)` Associate an `OdiLoadPlanVariable` to the current `OdiLoadPlanStep`.
`OdiLoadPlanStepVariable`	`addVariable(OdiLoadPlanVariable pOdiLoadPlanVariable, java.lang.Object pValue)` Associate an `OdiLoadPlanVariable` to the current `OdiLoadPlanStep`.
`OdiLoadPlanStep`	`copy(boolean generateName)` Deprecated. since 11.1.1.7.0 consider using `duplicate()` or `duplicate(OdiLoadPlanStep)` method.
`OdiLoadPlanStep`	`duplicate()` Create a duplicated step just placed just after this step/step container
`OdiLoadPlanStep`	`duplicate(OdiLoadPlanStep parentElement)`
`OdiLoadPlanException`	`getException()` Returns the exception step defined within this load plan to be executed in case this step is in Error. In case the step is defined in the step hierarchy of an exception, this method will throw an `UnsupportedOperationException`
`OdiLoadPlanStep.ExceptionBehavior`	`getExceptionBehavior()` Returns the exception behavior specifies how this step should behave in case an exception is encountered. In case the step is defined in the step hierarchy of an exception, this method will throw an `UnsupportedOperationException`
`java.io.Serializable`	`getInternalId()` Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
`java.util.Collection`	`getLoadPlanStepVariables()`
`int`	`getOrder()`
`OdiLoadPlanElement`	`getParentElement()`
`java.lang.String`	`getSessionKeywordsAsString()`
`int`	`getTimeout()`
`boolean`	`isEnabled()`
`void`	`regenerate(OdiLoadPlanStep.RegenerationMode pRegenerationMode, IOdiScenarioGenerator pScenarioGenerator)` Will regenerate all scenarios of this step and its children according to the specified RegenerationMode. If this step is a RunScenario step type it regenerates only this step scenario. This operation is not supported if the work repository is a runtime repository. This operation will not happen if one of the scenario original object doesn't exist anymore (throws `OdiOriginalObjectNotExistException`
`void`	`removeVariable(OdiLoadPlanStepVariable pOdiLoadPlanStepVariable)` Removes the `OdiLoadPlanStepVariable` from the list of the `OdiLoadPlanStep`
`void`	`setEnabled(boolean enabled)`
`void`	`setException(OdiLoadPlanException pException)` Defines the exception step within this load plan that will be executed in case this step is in Error. In case the step is defined in the step hierarchy of an exception, this method will throw an `UnsupportedOperationException`
`void`	`setExceptionBehavior(OdiLoadPlanStep.ExceptionBehavior exceptionBehavior)` Defines the exception behavior i.e.
`void`	`setSessionKeywordsAsString(java.lang.String sessionKeywordsAsString)`
`void`	`setTimeout(int timeout)`

Methods inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement
getLoadPlan, getName, getStepId, hasDisabledParent, setName, toString

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity
equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode

Methods inherited from class oracle.odi.domain.support.BusinessObject
clone

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SESSION_KEYWORDS_MAX_LENGTH
```
public static final int SESSION_KEYWORDS_MAX_LENGTH
```
    Maximum length for session keywords strings
    
    See Also:
    
    sessionKeywordsAsString, getSessionKeywordsAsString(), setSessionKeywordsAsString(String), Constant Field Values
  - MIN_PRIORITY
```
public static final int MIN_PRIORITY
```
    minimal value for property Priority
    
    See Also:
    
    #getPriority(), #setPriority(int), Constant Field Values
  - MAX_PRIORITY
```
public static final int MAX_PRIORITY
```
    maximal value for property Priority
    
    See Also:
    
    #getPriority(), #setPriority(int), Constant Field Values
- Method Detail
  - addVariable
```
public OdiLoadPlanStepVariable addVariable(OdiLoadPlanVariable pOdiLoadPlanVariable)
```
    Associate an OdiLoadPlanVariable to the current OdiLoadPlanStep. Adds it to the list and returns the corresponding OdiLoadPlanStepVariable
    This case is overriding a variable in refresh mode. Step and variable must be declared in the same parent load plan
    
    Parameters:
    
    pOdiLoadPlanVariable - the variable to associate to the step
    
    Returns:
    
    the OdiLoadPlanStepVariable created.
    
    Throws:
    
    DomainRuntimeException - if the odiLoadPlanVariable is not declared in the current OdiLoadPlan
    
    See Also:
    
    #removeVariable(OdiLoadPlanVariable), getLoadPlanStepVariables()
  - addVariable
```
public OdiLoadPlanStepVariable addVariable(OdiLoadPlanVariable pOdiLoadPlanVariable,
                                           java.lang.Object pValue)
```
    Associate an OdiLoadPlanVariable to the current OdiLoadPlanStep. Adds it to the list and returns the corresponding OdiLoadPlanStepVariable
    This case is overriding a variable and setting a new value. Step and variable must be declared in the same parent load plan
    
    Parameters:
    
    pOdiLoadPlanVariable - the variable to associate to the step
    
    pValue - the value used for this variable. Must be consistent with the datatype of the OdiLoadPlanVariable.
    
    Returns:
    
    the OdiLoadPlanStepVariable created.
    
    Throws:
    
    DomainRuntimeException - if the variable is not defined in the current loadplan
    
    DomainRuntimeException - if the value is not consistent with the variable datatype
    
    See Also:
    
    #removeVariable(OdiLoadPlanVariable), getLoadPlanStepVariables()
  - getLoadPlanStepVariables
```
public java.util.Collection getLoadPlanStepVariables()
```
    Returns:
    
    the unmodifiable collection of OdiLoadPlanStepVariable
    
    See Also:
    
    #addVariable(OdiLoadPlanVariable, boolean), #removeVariable(OdiLoadPlanVariable)
  - removeVariable
```
public void removeVariable(OdiLoadPlanStepVariable pOdiLoadPlanStepVariable)
```
    Removes the OdiLoadPlanStepVariable from the list of the OdiLoadPlanStep
    
    Parameters:
    
    pOdiLoadPlanVariable - the overridden variable to remove. Must not be null, and must be defined in the same load plan
    
    Throws:
    
    DomainRuntimeException - if the variable is null or not defined in the same loadplan
  - getSessionKeywordsAsString
```
public java.lang.String getSessionKeywordsAsString()
```
    Returns:
    
    Keywords for sessions created when executing this OdiLoadPlanException
    
    See Also:
    
    setSessionKeywordsAsString(String)
  - setSessionKeywordsAsString
```
public void setSessionKeywordsAsString(java.lang.String sessionKeywordsAsString)
```
    Parameters:
    
    sessionKeywordsAsString - Keywords for sessions created when executing this OdiLoadPlanException. Its length must be lower or equal to SESSION_KEYWORDS_MAX_LENGTH
    
    Throws:
    
    DomainRuntimeException - if the keywords are longer than SESSION_KEYWORDS_MAX_LENGTH
    
    See Also:
    
    getSessionKeywordsAsString(), SESSION_KEYWORDS_MAX_LENGTH
  - getExceptionBehavior
```
public OdiLoadPlanStep.ExceptionBehavior getExceptionBehavior()
```
    Returns the exception behavior specifies how this step should behave in case an exception is encountered.
    In case the step is defined in the step hierarchy of an exception, this method will throw an UnsupportedOperationException
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the step is part of an exception hierarchy
  - setExceptionBehavior
```
public void setExceptionBehavior(OdiLoadPlanStep.ExceptionBehavior exceptionBehavior)
```
    Defines the exception behavior i.e. how this step should behave in case an exception is encountered.
    
    Parameters:
    
    exceptionBehavior - Must not be null
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the step is part of an exception hierarchy
  - isEnabled
```
public boolean isEnabled()
```
    Specified by:
    
    isEnabled in class OdiLoadPlanElement
    
    Returns:
    
    0/1 to enable or disable this exception. Disabled steps are not executed in the overall load plan regardless of the enabled/disabled property of their sub-elements.
    
    See Also:
    
    setEnabled(boolean)
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Parameters:
    
    enabled - 0/1 to enable or disable this exception. Disabled steps are not executed in the overall load plan regardless of the enabled/disabled property of their sub-elements.
    
    See Also:
    
    isEnabled()
  - getOrder
```
public int getOrder()
```
    Returns:
    
    Defines the order of this step within its parent step. When the parent step is a serial step, the order defines the execution order.
    
    See Also:
    
    setOrder(int), OdiLoadPlanStepSerial
  - getTimeout
```
public int getTimeout()
```
    Returns:
    
    Timeout in seconds for this step. The timeout defines a maximum time that this step should take before being aborted by the Load Plan. A value of zero indicates an infinite timeout.
    . When a timeout is reached, the step is marked in error and the Exception associated is launched.
    
    See Also:
    
    setTimeout(int)
  - setTimeout
```
public void setTimeout(int timeout)
```
    Parameters:
    
    timeout - in seconds for this step. The timeout defines a maximum time that this step should take before being aborted by the Load Plan. A value of zero indicates an infinite timeout.
    It must be positive. When a timeout is reached, the step is marked in error and the Exception associated is launched.
    
    Throws:
    
    DomainRuntimeException - if the timeout is negative.
    
    See Also:
    
    getTimeout()
  - getException
```
public OdiLoadPlanException getException()
```
    Returns the exception step defined within this load plan to be executed in case this step is in Error.
    In case the step is defined in the step hierarchy of an exception, this method will throw an UnsupportedOperationException
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the step is part of an exception hierarchy
    
    See Also:
    
    setException(OdiLoadPlanException)
  - setException
```
public void setException(OdiLoadPlanException pException)
```
    Defines the exception step within this load plan that will be executed in case this step is in Error.
    In case the step is defined in the step hierarchy of an exception, this method will throw an UnsupportedOperationException
    
    Parameters:
    
    exception -
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the step is part of an exception hierarchy
    
    See Also:
    
    getException()
  - 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
  - getParentElement
```
public OdiLoadPlanElement getParentElement()
```
    Specified by:
    
    getParentElement in class OdiLoadPlanElement
    
    Returns:
    
    the parent element of the step in the hierarchy
  - regenerate
```
public void regenerate(OdiLoadPlanStep.RegenerationMode pRegenerationMode,
                       IOdiScenarioGenerator pScenarioGenerator)
```
    Will regenerate all scenarios of this step and its children according to the specified RegenerationMode.
    If this step is a RunScenario step type it regenerates only this step scenario.
    This operation is not supported if the work repository is a runtime repository.
    This operation will not happen if one of the scenario original object doesn't exist anymore (throws OdiOriginalObjectNotExistException
    
    Parameters:
    
    pRegenerationMode - Must not be null.
    
    pScenarioGenerator - The scenario generation service used. Must not be null.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the work repository is a runtime repository.
    
    DomainRuntimeException - if the regeneration mode is null.
    
    DomainRuntimeException - if the generation service is null.
    
    OdiOriginalObjectNotExistException - if the original object of a scenario doesn't exist.
  - copy
```
public OdiLoadPlanStep copy(boolean generateName)
```
    Deprecated. since 11.1.1.7.0 consider using duplicate() or duplicate(OdiLoadPlanStep) method.
    
    FOR INTERNAL USE ONLY
  - duplicate
```
public OdiLoadPlanStep duplicate()
```
    Create a duplicated step just placed just after this step/step container
    
    Returns:
  - duplicate
```
public OdiLoadPlanStep duplicate(OdiLoadPlanStep parentElement)
```
    Parameters:
    
    parentElement - container step on which we want to duplicate the current step

Class OdiLoadPlanStep

Nested Class Summary

Field Summary

Fields inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement

Method Summary

Methods inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

Methods inherited from class oracle.odi.domain.support.BusinessObject

Methods inherited from class java.lang.Object

Field Detail

SESSION_KEYWORDS_MAX_LENGTH

MIN_PRIORITY

MAX_PRIORITY

Method Detail

addVariable

addVariable

getLoadPlanStepVariables

removeVariable

getSessionKeywordsAsString

setSessionKeywordsAsString

getExceptionBehavior

setExceptionBehavior

isEnabled

setEnabled

getOrder

getTimeout

setTimeout

getException

setException

getInternalId

getParentElement

regenerate

copy

duplicate

duplicate