public class OdiLoadPlanStepRunScenario extends OdiLoadPlanStep
OdiLoadPlanStep
defining the execution of an OdiScenario
Modifier and Type | Class and Description |
---|---|
static class |
OdiLoadPlanStepRunScenario.RestartType
Restart behavior of this step when the Load Plan is restarted.
|
OdiLoadPlanStep.ExceptionBehavior, OdiLoadPlanStep.RegenerationMode
MAX_PRIORITY, MIN_PRIORITY, SESSION_KEYWORDS_MAX_LENGTH
NAME_MAX_LENGTH
Modifier and Type | Method and Description |
---|---|
OdiLoadPlanStepRunScenario |
copy(boolean generateName)
Deprecated.
since 11.1.1.7.0 consider using
OdiLoadPlanStep.duplicate() or OdiLoadPlanStep.duplicate(OdiLoadPlanStep) method. |
OdiContext |
getContext() |
java.lang.String |
getContextCode()
Return context code, if this step uses its own context for execution, or null if loadplan context is used.
|
OdiLogicalAgent |
getLogicalAgent() |
java.lang.String |
getLogicalAgentName() |
int |
getPriority() |
OdiLoadPlanStepRunScenario.RestartType |
getRestartType()
Returns the restart behavior of this step when the Load Plan is restarted.
In case the step is defined in the step hierarchy of an exception, this method will throw an UnsupportedOperationException |
Tag |
getScenarioTag() |
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 |
setContext(OdiContext context) |
void |
setLogicalAgent(OdiLogicalAgent logicalAgent) |
void |
setLogicalAgentName(java.lang.String agentName) |
void |
setPriority(int priority) |
void |
setRestartType(OdiLoadPlanStepRunScenario.RestartType restartType)
Defines the restart behavior of this step when the Load Plan is restarted.
|
void |
setScenarioTag(Tag pScenarioTag)
Sets the scenario tag to be called on this step
|
addVariable, addVariable, duplicate, duplicate, getException, getExceptionBehavior, getInternalId, getLoadPlanStepVariables, getOrder, getParentElement, getSessionKeywordsAsString, getTimeout, isEnabled, removeVariable, setEnabled, setException, setExceptionBehavior, setSessionKeywordsAsString, setTimeout
getName, getSecurityContainer, getStepId, hasDisabledParent, setName, toString
public OdiLoadPlanStepRunScenario.RestartType getRestartType()
UnsupportedOperationException
java.lang.UnsupportedOperationException
- if the step is part of an exception hierarchysetRestartType(RestartType)
,
OdiLoadPlanStepRunScenario.RestartType
public void setRestartType(OdiLoadPlanStepRunScenario.RestartType restartType)
restartType
- java.lang.UnsupportedOperationException
- if the step is part of an exception hierarchygetRestartType()
,
OdiLoadPlanStepRunScenario.RestartType
public Tag getScenarioTag()
setScenarioTag(Tag)
,
OdiScenario
,
Tag
public void setScenarioTag(Tag pScenarioTag)
pScenarioTag
- Tag
for the scenario to be calledpublic OdiContext getContext()
setContext(OdiContext)
,
OdiContext
public java.lang.String getContextCode()
public void setContext(OdiContext context)
context
- Forced Context that will be used to execute this Step.getContext()
,
OdiContext
public OdiLogicalAgent getLogicalAgent()
setLogicalAgent(OdiLogicalAgent)
,
OdiLogicalAgent
public java.lang.String getLogicalAgentName()
public void setLogicalAgent(OdiLogicalAgent logicalAgent)
logicalAgent
- Forced logical agent in charge of executing this Step.getLogicalAgent()
,
OdiLogicalAgent
public void setLogicalAgentName(java.lang.String agentName)
public void setPriority(int priority)
priority
- an integer priority for this step when this step is a RunScenario step in the ODI agent. Value range is 0 to 100 (100 being highest priority). Default is 0. The priority of a run scenario step is evaluated globally for all running load plans.DomainRuntimeException
- if the priority is not between #MAX_PRIORITY and #MIN_PRIORITYgetPriority()
,
OdiLoadPlanStep.MAX_PRIORITY
,
OdiLoadPlanStep.MIN_PRIORITY
public int getPriority()
setPriority(int)
,
OdiLoadPlanStep.MAX_PRIORITY
,
OdiLoadPlanStep.MIN_PRIORITY
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 OdiLoadPlanStepRunScenario copy(boolean generateName)
OdiLoadPlanStep.duplicate()
or OdiLoadPlanStep.duplicate(OdiLoadPlanStep)
method.FOR INTERNAL USE ONLY
copy
in class OdiLoadPlanStep