public class OdiLoadPlanException extends OdiLoadPlanElement
An OdiLoadPlanException represents some action that can be executed when the OdiLoadPlan
faces an error.
On each step, the OdiLoadPlan can define an OdiLoadPlanException
to be executed in such a case.
The OdiLoadPlan
manages a list of OdiLoadPlanException
.
The life cycle of an OdiLoadPlanException
is managed by the OdiLoadPlan.
It begins when a user creates adds a new exception to the OdiLoadPlan
.
The users can modify it in order to make it fit their needs.
The life cycle ends when a user removes the OdiLoadPlanException
from the list managed by the OdiLoadPlan.
Modifier and Type | Field and Description |
---|---|
static int |
SESSION_KEYWORDS_MAX_LENGTH
Maximum length for session keywords strings
|
NAME_MAX_LENGTH
Modifier and Type | Method and Description |
---|---|
void |
addStepToEnd(OdiLoadPlanStep pStep) |
OdiLoadPlanException |
duplicate() |
java.io.Serializable |
getInternalId()
Provides a common getter for the persistence layer to obtain an identity,
irrespective of the actual type of identity used.
|
OdiLoadPlanElement |
getParentElement() |
OdiLoadPlanStepSerial |
getRootStep() |
java.lang.String |
getSessionKeywordsAsString() |
boolean |
isEnabled() |
void |
moveAfter(OdiLoadPlanStep pStepToMove,
OdiLoadPlanStep pAfterThisStep) |
void |
moveBefore(OdiLoadPlanStep pStepToMove,
OdiLoadPlanStep pBeforeThisStep) |
void |
removeStep(OdiLoadPlanStep pOdiLoadPlanStep) |
void |
setEnabled(boolean enabled) |
void |
setSessionKeywordsAsString(java.lang.String sessionKeywordsAsString) |
getName, getSecurityContainer, getStepId, hasDisabledParent, setName, toString
public static final int SESSION_KEYWORDS_MAX_LENGTH
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 OdiLoadPlanStepSerial getRootStep()
OdiLoadPlanException
public 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 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
if
- the keywords are longer than SESSION_KEYWORDS_MAX_LENGTH
getSessionKeywordsAsString()
,
SESSION_KEYWORDS_MAX_LENGTH
public void moveBefore(OdiLoadPlanStep pStepToMove, OdiLoadPlanStep pBeforeThisStep)
public void addStepToEnd(OdiLoadPlanStep pStep)
public void moveAfter(OdiLoadPlanStep pStepToMove, OdiLoadPlanStep pAfterThisStep)
public void removeStep(OdiLoadPlanStep pOdiLoadPlanStep)
public OdiLoadPlanException duplicate()
public OdiLoadPlanElement getParentElement()
getParentElement
in class OdiLoadPlanElement