oracle.odi.domain.runtime.loadplan

Class OdiLoadPlanStepRunScenario

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

oracle.odi.domain.runtime.loadplan.OdiLoadPlanStepRunScenario

All Implemented Interfaces:

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

public class OdiLoadPlanStepRunScenario
extends OdiLoadPlanStep

Concrete class for OdiLoadPlanStep defining the execution of an OdiScenario

Since:

11.1.1.5.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OdiLoadPlanStepRunScenario.RestartType Restart behavior of this step when the Load Plan is restarted.

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

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

addVariable, addVariable, duplicate, duplicate, getException, getExceptionBehavior, getInternalId, getLoadPlanStepVariables, getOrder, getParentElement, getSessionKeywordsAsString, getTimeout, isEnabled, removeVariable, setEnabled, setException, setExceptionBehavior, setSessionKeywordsAsString, setTimeout

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

Method Detail

getRestartType

public 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

Throws:

java.lang.UnsupportedOperationException - if the step is part of an exception hierarchy

See Also:

setRestartType(RestartType), OdiLoadPlanStepRunScenario.RestartType

setRestartType

public void setRestartType(OdiLoadPlanStepRunScenario.RestartType restartType)

Defines the restart behavior of this step when the Load Plan is restarted.

Parameters:

restartType -

Throws:

java.lang.UnsupportedOperationException - if the step is part of an exception hierarchy

See Also:

getRestartType(), OdiLoadPlanStepRunScenario.RestartType

getScenarioTag

public Tag getScenarioTag()

Returns:

The scenario tag, which will be executed

See Also:

setScenarioTag(Tag), OdiScenario, Tag

setScenarioTag

public void setScenarioTag(Tag pScenarioTag)

Sets the scenario tag to be called on this step

Parameters:

pScenarioTag - Tag for the scenario to be called

getContext

public OdiContext getContext()

Returns:

Forced Context that will be used to execute this Step.

See Also:

setContext(OdiContext), OdiContext

getContextCode

public java.lang.String getContextCode()

Return context code, if this step uses its own context for execution, or null if loadplan context is used.

Returns:

context code.

setContext

public void setContext(OdiContext context)

Parameters:

context - Forced Context that will be used to execute this Step.

See Also:

getContext(), OdiContext

getLogicalAgent

public OdiLogicalAgent getLogicalAgent()

Returns:

Forced logical agent in charge of executing this Step.

See Also:

setLogicalAgent(OdiLogicalAgent), OdiLogicalAgent

getLogicalAgentName

public java.lang.String getLogicalAgentName()

setLogicalAgent

public void setLogicalAgent(OdiLogicalAgent logicalAgent)

Parameters:

logicalAgent - Forced logical agent in charge of executing this Step.

See Also:

getLogicalAgent(), OdiLogicalAgent

setLogicalAgentName

public void setLogicalAgentName(java.lang.String agentName)

setPriority

public void setPriority(int priority)

Parameters:

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.

Throws:

DomainRuntimeException - if the priority is not between #MAX_PRIORITY and #MIN_PRIORITY

See Also:

getPriority(), OdiLoadPlanStep.MAX_PRIORITY, OdiLoadPlanStep.MIN_PRIORITY

getPriority

public int getPriority()

Returns:

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.

See Also:

setPriority(int), OdiLoadPlanStep.MAX_PRIORITY, OdiLoadPlanStep.MIN_PRIORITY

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 OdiLoadPlanStepRunScenario 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