|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.5.0) E17060-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public abstract class OdiLoadPlanStep
The OdiLoadPlanStep
is an abstract class for the steps of the aggregate OdiLoadPlan.
The implementations are:
The implementations have different behavior in regards to the OdiLoadPlan
, this class helps share the common behavior and properties
The life cycle of an OdiLoadPlanStep
begins when a user adds one of its implementation to the list of the steps of the OdiLoadPlan
.
Users can modify the steps in order to make them fit their needs.
The life cycle ends when the step is removed from the list of steps of the OdiLoadPlan
Order is managed at creation time. When moving, order is managed by the step container. Order is then managed when removing a child.
Nested Class Summary | |
---|---|
static class |
OdiLoadPlanStep.ExceptionBehavior Behavior in case the OdiLoadPlanStep execution throws an exception. |
static class |
OdiLoadPlanStep.RegenerationMode Defines the regeneration modes of a step |
Field Summary | |
---|---|
static int |
MAX_PRIORITY maximal value for property Priority |
static int |
MIN_PRIORITY minimal value for property Priority |
static int |
SESSION_KEYWORDS_MAX_LENGTH Maximum length for session keywords strings |
Fields inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement |
---|
NAME_MAX_LENGTH |
Method Summary | |
---|---|
OdiLoadPlanStepVariable |
addVariable(OdiLoadPlanVariable pOdiLoadPlanVariable) Associate an OdiLoadPlanVariable to the current OdiLoadPlanStep . |
OdiLoadPlanStepVariable |
addVariable(OdiLoadPlanVariable pOdiLoadPlanVariable, java.lang.Object pValue) Associate an OdiLoadPlanVariable to the current OdiLoadPlanStep . |
OdiLoadPlanStep |
copy(boolean generateName) |
OdiLoadPlanStep |
duplicate() Create a duplicated step just placed just after this step/step container |
OdiLoadPlanStep |
duplicate(OdiLoadPlanStep parentElement) |
OdiLoadPlanException |
getException() Returns the exception step defined within this load plan to be executed in case this step is in Error. In case the step is defined in the step hierarchy of an exception, this method will throw an UnsupportedOperationException |
OdiLoadPlanStep.ExceptionBehavior |
getExceptionBehavior() Returns the exception behavior specifies how this step should behave in case an exception is encountered. In case the step is defined in the step hierarchy of an exception, this method will throw an UnsupportedOperationException |
java.io.Serializable |
getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used. |
java.util.Collection<OdiLoadPlanStepVariable> |
getLoadPlanStepVariables() |
int |
getOrder() |
OdiLoadPlanElement |
getParentElement() |
java.lang.String |
getSessionKeywordsAsString() |
int |
getTimeout() |
boolean |
isEnabled() |
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 |
removeVariable(OdiLoadPlanStepVariable pOdiLoadPlanStepVariable) Removes the OdiLoadPlanStepVariable from the list of the OdiLoadPlanStep |
void |
setEnabled(boolean enabled) |
void |
setException(OdiLoadPlanException pException) Defines the exception step within this load plan that will be executed in case this step is in Error. In case the step is defined in the step hierarchy of an exception, this method will throw an UnsupportedOperationException |
void |
setExceptionBehavior(OdiLoadPlanStep.ExceptionBehavior exceptionBehavior) Defines the exception behavior i.e. |
void |
setSessionKeywordsAsString(java.lang.String sessionKeywordsAsString) |
void |
setTimeout(int timeout) |
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 |
Field Detail |
---|
public static final int SESSION_KEYWORDS_MAX_LENGTH
sessionKeywordsAsString
, getSessionKeywordsAsString()
, setSessionKeywordsAsString(String)
, Constant Field Valuespublic static final int MIN_PRIORITY
#getPriority()
, #setPriority(int)
, Constant Field Valuespublic static final int MAX_PRIORITY
#getPriority()
, #setPriority(int)
, Constant Field ValuesMethod Detail |
---|
public OdiLoadPlanStepVariable addVariable(OdiLoadPlanVariable pOdiLoadPlanVariable)
OdiLoadPlanVariable
to the current OdiLoadPlanStep
. Adds it to the list and returns the corresponding OdiLoadPlanStepVariable
pOdiLoadPlanVariable
- the variable to associate to the stepOdiLoadPlanStepVariable
created.java.lang.IllegalArgumentException
- if the odiLoadPlanVariable is not declared in the current OdiLoadPlan
#removeVariable(OdiLoadPlanVariable)
, getLoadPlanStepVariables()
public OdiLoadPlanStepVariable addVariable(OdiLoadPlanVariable pOdiLoadPlanVariable, java.lang.Object pValue)
OdiLoadPlanVariable
to the current OdiLoadPlanStep
. Adds it to the list and returns the corresponding OdiLoadPlanStepVariable
pOdiLoadPlanVariable
- the variable to associate to the steppValue
- the value used for this variable. Must be consistent with the datatype of the OdiLoadPlanVariable.OdiLoadPlanStepVariable
created.java.lang.IllegalArgumentException
- if the variable is not defined in the current loadplanjava.lang.IllegalArgumentException
- if the value is not consistent with the variable datatype#removeVariable(OdiLoadPlanVariable)
, getLoadPlanStepVariables()
public java.util.Collection<OdiLoadPlanStepVariable> getLoadPlanStepVariables()
OdiLoadPlanStepVariable
#addVariable(OdiLoadPlanVariable, boolean)
, #removeVariable(OdiLoadPlanVariable)
public void removeVariable(OdiLoadPlanStepVariable pOdiLoadPlanStepVariable)
OdiLoadPlanStepVariable
from the list of the OdiLoadPlanStep
pOdiLoadPlanVariable
- the overridden variable to remove. Must not be null, and must be defined in the same load planjava.lang.IllegalArgumentException
- if the variable is null or not defined in the same loadplanpublic java.lang.String getSessionKeywordsAsString()
OdiLoadPlanException
setSessionKeywordsAsString(String)
public void setSessionKeywordsAsString(java.lang.String sessionKeywordsAsString)
sessionKeywordsAsString
- Keywords for sessions created when executing this OdiLoadPlanException
. Its length must be lower or equal to SESSION_KEYWORDS_MAX_LENGTH
java.lang.IllegalArgumentException
- if the keywords are longer than SESSION_KEYWORDS_MAX_LENGTH
getSessionKeywordsAsString()
, SESSION_KEYWORDS_MAX_LENGTH
public OdiLoadPlanStep.ExceptionBehavior getExceptionBehavior()
UnsupportedOperationException
java.lang.UnsupportedOperationException
- if the step is part of an exception hierarchypublic void setExceptionBehavior(OdiLoadPlanStep.ExceptionBehavior exceptionBehavior)
exceptionBehavior
- Must not be nulljava.lang.UnsupportedOperationException
- if the step is part of an exception hierarchypublic boolean isEnabled()
isEnabled
in class OdiLoadPlanElement
setEnabled(boolean)
public void setEnabled(boolean enabled)
enabled
- 0/1 to enable or disable this exception. Disabled steps are not executed in the overall load plan regardless of the enabled/disabled property of their sub-elements.isEnabled()
public int getOrder()
setOrder(int)
, OdiLoadPlanStepSerial
public int getTimeout()
setTimeout(int)
public void setTimeout(int timeout)
timeout
- in seconds for this step. The timeout defines a maximum time that this step should take before being aborted by the Load Plan. A value of zero indicates an infinite timeout.java.lang.IllegalArgumentException
- if the timeout is negative.getTimeout()
public OdiLoadPlanException getException()
UnsupportedOperationException
java.lang.UnsupportedOperationException
- if the step is part of an exception hierarchysetException(OdiLoadPlanException)
public void setException(OdiLoadPlanException pException)
UnsupportedOperationException
exception
-java.lang.UnsupportedOperationException
- if the step is part of an exception hierarchygetException()
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.
public OdiLoadPlanElement getParentElement()
getParentElement
in class OdiLoadPlanElement
public 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
pRegenerationMode
- Must not be null.pScenarioGenerator
- The scenario generation service used. Must not be null.java.lang.UnsupportedOperationException
- if the work repository is a runtime repository.java.lang.IllegalArgumentException
- if the regeneration mode is null.java.lang.IllegalArgumentException
- if the generation service is null.OdiOriginalObjectNotExistException
- if the original object of a scenario doesn't exist.public OdiLoadPlanStep copy(boolean generateName)
public OdiLoadPlanStep duplicate()
public OdiLoadPlanStep duplicate(OdiLoadPlanStep parentElement)
parentElement
- container step on which we want to duplicate the current step
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.5.0) E17060-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |