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 OdiLoadPlanStepContainer

java.lang.Object
  extended by oracle.odi.domain.support.BusinessObject
      extended by oracle.odi.domain.support.AbstractRepositoryEntity
          extended by oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement
              extended by oracle.odi.domain.runtime.loadplan.OdiLoadPlanStep
                  extended by oracle.odi.domain.runtime.loadplan.OdiLoadPlanStepContainer

All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, IRepositoryEntity
Direct Known Subclasses:
OdiLoadPlanStepParallel, OdiLoadPlanStepSerial

public abstract class OdiLoadPlanStepContainer
extends OdiLoadPlanStep

This abstract class represents the steps that serve as container for other steps. They own and manage a list of children steps.

Since:
11.1.1.5.0
See Also:
Serialized Form

Nested Class Summary

 

Nested classes/interfaces inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanStep
OdiLoadPlanStep.ExceptionBehavior, OdiLoadPlanStep.RegenerationMode

 

Field Summary

 

Fields inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanStep
MAX_PRIORITY, MIN_PRIORITY, SESSION_KEYWORDS_MAX_LENGTH

 

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

 

Method Summary
 OdiLoadPlanStepCase addStepCase(java.lang.String pStepName, OdiLoadPlanVariable pVariable)
          Creates an instance of OdiLoadPlanStepCase, adds it to the list of children steps in the last position and returns it.
 OdiLoadPlanStepParallel addStepParallel(java.lang.String pStepName)
          Creates an instance of OdiLoadPlanStepParallel, adds it to the list of children steps in the last position and returns it.
 OdiLoadPlanStepRunScenario addStepRunScenario(java.lang.String pStepName, OdiScenario pScenario, OdiLogicalAgent pLogicalAgent, OdiContext pContext)
          Creates an instance of OdiLoadPlanStepRunScenario, adds it to the list of children steps in the last position and returns it.
 OdiLoadPlanStepRunScenario addStepRunScenario(java.lang.String pStepName, Tag pScenarioTag, OdiLogicalAgent pLogicalAgent, OdiContext pContext)
          Creates an instance of OdiLoadPlanStepRunScenario, adds it to the list of children steps in the last position and returns it.
 OdiLoadPlanStepSerial addStepSerial(java.lang.String pStepName)
          Creates an instance of OdiLoadPlanStepSerial, adds it to the list of children steps in the last position and returns it.
 void addStepToEnd(OdiLoadPlanStep pStep)
           
 OdiLoadPlanStep copy(boolean generateName)
           
 java.util.List<OdiLoadPlanStep> getChildrenSteps()
           
 java.io.Serializable getInternalId()
          Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
 void moveAfter(OdiLoadPlanStep pStepToMove, OdiLoadPlanStep pAfterThisStep)
          Moves the given step in the children list, putting it right after the second parameter step.
 void moveBefore(OdiLoadPlanStep pStepToMove, OdiLoadPlanStep pBeforeThisStep)
          Moves the given step in the children list, putting it right before the second parameter step.
No action if pStepToMove is already right before pBeforeThisStep.
 int prepareForMovingSteps(OdiLoadPlanStep pStepToMove, OdiLoadPlanStep targetStep)
           
 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 removeStep(OdiLoadPlanStep pOdiLoadPlanStep)
          Removes the given step of the list of children steps and updates the order for the remaining children steps.

 

Methods inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanStep
addVariable, addVariable, duplicate, duplicate, getException, getExceptionBehavior, getLoadPlanStepVariables, getOrder, getParentElement, getSessionKeywordsAsString, getTimeout, isEnabled, removeVariable, setEnabled, setException, setExceptionBehavior, setSessionKeywordsAsString, setTimeout

 

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

 

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.

Specified by:
getInternalId in interface IRepositoryEntity
Overrides:
getInternalId in class OdiLoadPlanStep
Returns:
the persistence identity of this instance

addStepCase

public OdiLoadPlanStepCase addStepCase(java.lang.String pStepName,
                                       OdiLoadPlanVariable pVariable)
Creates an instance of OdiLoadPlanStepCase, adds it to the list of children steps in the last position and returns it.
Parameters:
pStepName - the name of the new OdiLoadPlanStepCase
pVariable - the OdiLoadPlanVariable on which the OdiLoadPlanStepCase will rely
Returns:
the OdiLoadPlanStepCase created
See Also:
#addStepParallel(String, int), addStepRunScenario(String, OdiScenario, OdiLogicalAgent, OdiContext), addStepSerial(String), removeStep(OdiLoadPlanStep), getChildrenSteps()

addStepRunScenario

public OdiLoadPlanStepRunScenario addStepRunScenario(java.lang.String pStepName,
                                                     OdiScenario pScenario,
                                                     OdiLogicalAgent pLogicalAgent,
                                                     OdiContext pContext)
Creates an instance of OdiLoadPlanStepRunScenario, adds it to the list of children steps in the last position and returns it.
Parameters:
pStepName - the name of the new OdiLoadPlanStepRunScenario. Must not be null, empty or longer than #NAME_MAX_LENGTH.
pScenario - the OdiScenario that the step must run. Must not be null
pLogicalAgent - the OdiLogicalAgent on which the OdiScenario must be run
pContext - the OdiContext on which the OdiScenario must be run
Returns:
the OdiLoadPlanStepRunScenario created
Throws:
java.lang.IllegalArgumentException - if the name is null, empty or longer than #NAME_MAX_LENGTH.
java.lang.IllegalArgumentException - if the scenario is null
See Also:
addStepCase(String, OdiLoadPlanVariable), #addStepParallel(String, int), addStepSerial(String), removeStep(OdiLoadPlanStep), getChildrenSteps()

addStepRunScenario

public OdiLoadPlanStepRunScenario addStepRunScenario(java.lang.String pStepName,
                                                     Tag pScenarioTag,
                                                     OdiLogicalAgent pLogicalAgent,
                                                     OdiContext pContext)
Creates an instance of OdiLoadPlanStepRunScenario, adds it to the list of children steps in the last position and returns it.
Parameters:
pStepName - the name of the new OdiLoadPlanStepRunScenario. Must not be null, empty or longer than #NAME_MAX_LENGTH.
pScenarioTag - the Tag identifier for OdiScenario that the step must run. Must not be null
pLogicalAgent - the OdiLogicalAgent on which the OdiScenario must be run
pContext - the OdiContext on which the OdiScenario must be run
Returns:
the OdiLoadPlanStepRunScenario created
Throws:
java.lang.IllegalArgumentException - if the name is null, empty or longer than #NAME_MAX_LENGTH.
java.lang.IllegalArgumentException - if the scenario tag is null
See Also:
addStepCase(String, OdiLoadPlanVariable), #addStepParallel(String, int), addStepSerial(String), removeStep(OdiLoadPlanStep), getChildrenSteps()

removeStep

public void removeStep(OdiLoadPlanStep pOdiLoadPlanStep)
Removes the given step of the list of children steps and updates the order for the remaining children steps.
Parameters:
pOdiLoadPlanStep - the step to remove. Must not be null or defined in another loadplan
Throws:
java.lang.IllegalArgumentException - if the step is null or defined in another loadplan
See Also:
addStepCase(String, OdiLoadPlanVariable), #addStepParallel(String, int), addStepRunScenario(String, OdiScenario, OdiLogicalAgent, OdiContext), addStepSerial(String), getChildrenSteps()

getChildrenSteps

public java.util.List<OdiLoadPlanStep> getChildrenSteps()
Returns:
the unmodifiable collection of children OdiLoadPlanStep for this step
See Also:
addStepCase(String, OdiLoadPlanVariable), #addStepParallel(String, int), addStepRunScenario(String, OdiScenario, OdiLogicalAgent, OdiContext), addStepSerial(String), removeStep(OdiLoadPlanStep)

addStepSerial

public OdiLoadPlanStepSerial addStepSerial(java.lang.String pStepName)
Creates an instance of OdiLoadPlanStepSerial, adds it to the list of children steps in the last position and returns it.
Parameters:
pStepName - the name of the new OdiLoadPlanStepSerial. Must not be null, empty or longer than #NAME_MAX_LENGTH.
Returns:
the OdiLoadPlanStepSerial created
Throws:
java.lang.IllegalArgumentException - if the name is null, empty or longer than #NAME_MAX_LENGTH.
See Also:
addStepCase(String, OdiLoadPlanVariable), #addStepParallel(String, int), addStepRunScenario(String, OdiScenario, OdiLogicalAgent, OdiContext), removeStep(OdiLoadPlanStep), getChildrenSteps()

addStepParallel

public OdiLoadPlanStepParallel addStepParallel(java.lang.String pStepName)
Creates an instance of OdiLoadPlanStepParallel, adds it to the list of children steps in the last position and returns it.
Parameters:
pStepName - the name of the new OdiLoadPlanStepParallel. Must not be null, empty or longer than #NAME_MAX_LENGTH.
Returns:
the OdiLoadPlanStepParallel created
Throws:
java.lang.IllegalArgumentException - if the name is null, empty or longer than #NAME_MAX_LENGTH.
See Also:
addStepCase(String, OdiLoadPlanVariable), addStepRunScenario(String, OdiScenario, OdiLogicalAgent, OdiContext), addStepSerial(String), removeStep(OdiLoadPlanStep), getChildrenSteps()

prepareForMovingSteps

public int prepareForMovingSteps(OdiLoadPlanStep pStepToMove,
                                 OdiLoadPlanStep targetStep)

moveAfter

public void moveAfter(OdiLoadPlanStep pStepToMove,
                      OdiLoadPlanStep pAfterThisStep)
Moves the given step in the children list, putting it right after the second parameter step.
No action if pStepToMove is already right after pAfterThisStep.
Parameters:
pStepToMove -
pAfterThisStep -
Throws:
java.lang.IllegalArgumentException - if the steps are not defined in the same step container

moveBefore

public void moveBefore(OdiLoadPlanStep pStepToMove,
                       OdiLoadPlanStep pBeforeThisStep)
Moves the given step in the children list, putting it right before the second parameter step.
No action if pStepToMove is already right before pBeforeThisStep.
Parameters:
pStepToMove -
pBeforeThisStep -
Throws:
java.lang.IllegalArgumentException - if the steps are not defined in the same step container

addStepToEnd

public void addStepToEnd(OdiLoadPlanStep pStep)

regenerate

public void regenerate(OdiLoadPlanStep.RegenerationMode pRegenerationMode,
                       IOdiScenarioGenerator pScenarioGenerator)
Description copied from class: OdiLoadPlanStep

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

Overrides:
regenerate in class OdiLoadPlanStep
Parameters:
pRegenerationMode - Must not be null.
pScenarioGenerator - The scenario generation service used. Must not be null.

copy

public OdiLoadPlanStep copy(boolean generateName)
Overrides:
copy in class OdiLoadPlanStep

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.