oracle.odi.domain.runtime.loadplan

Class OdiLoadPlanStepContainer

java.lang.Object

AbstractRepositoryEntity

oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement

oracle.odi.domain.runtime.loadplan.OdiLoadPlanStep

oracle.odi.domain.runtime.loadplan.OdiLoadPlanStepContainer

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

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

Modifier and Type	Method and Description
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) Adds the OdiLoadPlanStep as the last child of this OdiLoadPlanStepContainer.
OdiLoadPlanStep	copy(boolean generateName) Deprecated. since 11.1.1.7.0 consider using OdiLoadPlanStep.duplicate() or OdiLoadPlanStep.duplicate(OdiLoadPlanStep) method.
java.util.List	getChildrenSteps()
java.io.Serializable	getInternalId()
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

getLoadPlan, getName, getSecurityContainer, getStepId, hasDisabledParent, setName, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInternalId

public java.io.Serializable getInternalId()

Overrides:

getInternalId in class OdiLoadPlanStep

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:

DomainRuntimeException - if the name is null, empty or longer than #NAME_MAX_LENGTH.

DomainRuntimeException - 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:

DomainRuntimeException - if the name is null, empty or longer than #NAME_MAX_LENGTH.

DomainRuntimeException - 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:

DomainRuntimeException - 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 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:

DomainRuntimeException - 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:

DomainRuntimeException - 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:

DomainRuntimeException - 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:

DomainRuntimeException - if the steps are not defined in the same step container

addStepToEnd

public void addStepToEnd(OdiLoadPlanStep pStep)

Adds the OdiLoadPlanStep as the last child of this OdiLoadPlanStepContainer.

It is not possible to add the step belonging to a different OdiLoadPlan.

Parameters:

pStep - OdiLoadPlanStep to add

Throws:

DomainRuntimeException - if pStep belongs to a different OdiLoadPlan

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)

Deprecated. since 11.1.1.7.0 consider using OdiLoadPlanStep.duplicate() or OdiLoadPlanStep.duplicate(OdiLoadPlanStep) method.

FOR INTERNAL USE ONLY

Overrides:

copy in class OdiLoadPlanStep