public abstract class OdiLoadPlanStepContainer extends OdiLoadPlanStep
OdiLoadPlanStep.ExceptionBehavior, OdiLoadPlanStep.RegenerationMode
MAX_PRIORITY, MIN_PRIORITY, SESSION_KEYWORDS_MAX_LENGTH
NAME_MAX_LENGTH
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()
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.
|
addVariable, addVariable, duplicate, duplicate, getException, getExceptionBehavior, getLoadPlanStepVariables, getOrder, getParentElement, getSessionKeywordsAsString, getTimeout, isEnabled, removeVariable, setEnabled, setException, setExceptionBehavior, setSessionKeywordsAsString, setTimeout
getName, getSecurityContainer, getStepId, hasDisabledParent, setName, toString
public java.io.Serializable getInternalId()
IRepositoryEntity
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.
getInternalId
in interface IRepositoryEntity
getInternalId
in class OdiLoadPlanStep
public OdiLoadPlanStepCase addStepCase(java.lang.String pStepName, OdiLoadPlanVariable pVariable)
OdiLoadPlanStepCase
, adds it to the list of children steps in the last position and returns it.pStepName
- the name of the new OdiLoadPlanStepCase
pVariable
- the OdiLoadPlanVariable
on which the OdiLoadPlanStepCase
will relyOdiLoadPlanStepCase
created#addStepParallel(String, int)
,
addStepRunScenario(String, OdiScenario, OdiLogicalAgent, OdiContext)
,
addStepSerial(String)
,
removeStep(OdiLoadPlanStep)
,
getChildrenSteps()
public OdiLoadPlanStepRunScenario addStepRunScenario(java.lang.String pStepName, OdiScenario pScenario, OdiLogicalAgent pLogicalAgent, OdiContext pContext)
OdiLoadPlanStepRunScenario
, adds it to the list of children steps in the last position and returns it.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 nullpLogicalAgent
- the OdiLogicalAgent
on which the OdiScenario
must be runpContext
- the OdiContext
on which the OdiScenario
must be runOdiLoadPlanStepRunScenario
createdDomainRuntimeException
- if the name is null, empty or longer than #NAME_MAX_LENGTH.DomainRuntimeException
- if the scenario is nulladdStepCase(String, OdiLoadPlanVariable)
,
#addStepParallel(String, int)
,
addStepSerial(String)
,
removeStep(OdiLoadPlanStep)
,
getChildrenSteps()
public OdiLoadPlanStepRunScenario addStepRunScenario(java.lang.String pStepName, Tag pScenarioTag, OdiLogicalAgent pLogicalAgent, OdiContext pContext)
OdiLoadPlanStepRunScenario
, adds it to the list of children steps in the last position and returns it.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 nullpLogicalAgent
- the OdiLogicalAgent
on which the OdiScenario
must be runpContext
- the OdiContext
on which the OdiScenario
must be runOdiLoadPlanStepRunScenario
createdDomainRuntimeException
- if the name is null, empty or longer than #NAME_MAX_LENGTH.DomainRuntimeException
- if the scenario tag is nulladdStepCase(String, OdiLoadPlanVariable)
,
#addStepParallel(String, int)
,
addStepSerial(String)
,
removeStep(OdiLoadPlanStep)
,
getChildrenSteps()
public void removeStep(OdiLoadPlanStep pOdiLoadPlanStep)
pOdiLoadPlanStep
- the step to remove. Must not be null or defined in another loadplanDomainRuntimeException
- if the step is null or defined in another loadplanaddStepCase(String, OdiLoadPlanVariable)
,
#addStepParallel(String, int)
,
addStepRunScenario(String, OdiScenario, OdiLogicalAgent, OdiContext)
,
addStepSerial(String)
,
getChildrenSteps()
public java.util.List getChildrenSteps()
OdiLoadPlanStep
for this stepaddStepCase(String, OdiLoadPlanVariable)
,
#addStepParallel(String, int)
,
addStepRunScenario(String, OdiScenario, OdiLogicalAgent, OdiContext)
,
addStepSerial(String)
,
removeStep(OdiLoadPlanStep)
public OdiLoadPlanStepSerial addStepSerial(java.lang.String pStepName)
OdiLoadPlanStepSerial
, adds it to the list of children steps in the last position and returns it.pStepName
- the name of the new OdiLoadPlanStepSerial
. Must not be null, empty or longer than #NAME_MAX_LENGTH.OdiLoadPlanStepSerial
createdDomainRuntimeException
- if the name is null, empty or longer than #NAME_MAX_LENGTH.addStepCase(String, OdiLoadPlanVariable)
,
#addStepParallel(String, int)
,
addStepRunScenario(String, OdiScenario, OdiLogicalAgent, OdiContext)
,
removeStep(OdiLoadPlanStep)
,
getChildrenSteps()
public OdiLoadPlanStepParallel addStepParallel(java.lang.String pStepName)
OdiLoadPlanStepParallel
, adds it to the list of children steps in the last position and returns it.pStepName
- the name of the new OdiLoadPlanStepParallel
. Must not be null, empty or longer than #NAME_MAX_LENGTH.OdiLoadPlanStepParallel
createdDomainRuntimeException
- if the name is null, empty or longer than #NAME_MAX_LENGTH.addStepCase(String, OdiLoadPlanVariable)
,
addStepRunScenario(String, OdiScenario, OdiLogicalAgent, OdiContext)
,
addStepSerial(String)
,
removeStep(OdiLoadPlanStep)
,
getChildrenSteps()
public int prepareForMovingSteps(OdiLoadPlanStep pStepToMove, OdiLoadPlanStep targetStep)
public void moveAfter(OdiLoadPlanStep pStepToMove, OdiLoadPlanStep pAfterThisStep)
pStepToMove
- pAfterThisStep
- DomainRuntimeException
- if the steps are not defined in the same step containerpublic void moveBefore(OdiLoadPlanStep pStepToMove, OdiLoadPlanStep pBeforeThisStep)
pStepToMove
- pBeforeThisStep
- DomainRuntimeException
- if the steps are not defined in the same step containerpublic void addStepToEnd(OdiLoadPlanStep pStep)
OdiLoadPlanStep
as the last child of this OdiLoadPlanStepContainer
.
It is not possible to add the step belonging to a different OdiLoadPlan
.
pStep
- OdiLoadPlanStep
to addDomainRuntimeException
- if pStep belongs to a different OdiLoadPlan
public void regenerate(OdiLoadPlanStep.RegenerationMode pRegenerationMode, IOdiScenarioGenerator pScenarioGenerator)
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
regenerate
in class OdiLoadPlanStep
pRegenerationMode
- Must not be null.pScenarioGenerator
- The scenario generation service used. Must not be null.public OdiLoadPlanStep copy(boolean generateName)
OdiLoadPlanStep.duplicate()
or OdiLoadPlanStep.duplicate(OdiLoadPlanStep)
method.FOR INTERNAL USE ONLY
copy
in class OdiLoadPlanStep