oracle.odi.domain.runtime.loadplan

Class OdiLoadPlanException

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement

oracle.odi.domain.runtime.loadplan.OdiLoadPlanException

All Implemented Interfaces:

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

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.

Since:

11.1.1.5.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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

Modifier and Type	Method and Description
void	addReferringStep(OdiLoadPlanStep referringStep)
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()
java.util.Collection	getReferringSteps()
OdiLoadPlanStepSerial	getRootStep()
java.lang.String	getSessionKeywordsAsString()
boolean	isEnabled()
void	moveAfter(OdiLoadPlanStep pStepToMove, OdiLoadPlanStep pAfterThisStep)
void	moveBefore(OdiLoadPlanStep pStepToMove, OdiLoadPlanStep pBeforeThisStep)
void	removeReferringStep(OdiLoadPlanStep referringStep)
void	removeStep(OdiLoadPlanStep pOdiLoadPlanStep)
void	setEnabled(boolean enabled)
void	setSessionKeywordsAsString(java.lang.String sessionKeywordsAsString)

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

Field Detail

SESSION_KEYWORDS_MAX_LENGTH

public static final int SESSION_KEYWORDS_MAX_LENGTH

Maximum length for session keywords strings

See Also:

sessionKeywordsAsString, getSessionKeywordsAsString(), setSessionKeywordsAsString(String), Constant Field Values

Method Detail

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IRepositoryEntity

Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

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.

Returns:

the persistence identity of this instance

getRootStep

public OdiLoadPlanStepSerial getRootStep()

Returns:

the first level step for the OdiLoadPlanException

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in class OdiLoadPlanElement

Returns:

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.

See Also:

setEnabled(boolean)

setEnabled

public void setEnabled(boolean enabled)

Parameters:

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.

See Also:

isEnabled()

getSessionKeywordsAsString

public java.lang.String getSessionKeywordsAsString()

Returns:

Keywords for sessions created when executing this OdiLoadPlanException

See Also:

setSessionKeywordsAsString(String)

setSessionKeywordsAsString

public void setSessionKeywordsAsString(java.lang.String sessionKeywordsAsString)

Parameters:

sessionKeywordsAsString - Keywords for sessions created when executing this OdiLoadPlanException. Its length must be lower or equal to SESSION_KEYWORDS_MAX_LENGTH

Throws:

if - the keywords are longer than SESSION_KEYWORDS_MAX_LENGTH

See Also:

getSessionKeywordsAsString(), SESSION_KEYWORDS_MAX_LENGTH

getReferringSteps

public java.util.Collection getReferringSteps()

addReferringStep

public void addReferringStep(OdiLoadPlanStep referringStep)

removeReferringStep

public void removeReferringStep(OdiLoadPlanStep referringStep)

moveBefore

public void moveBefore(OdiLoadPlanStep pStepToMove,
                       OdiLoadPlanStep pBeforeThisStep)

addStepToEnd

public void addStepToEnd(OdiLoadPlanStep pStep)

moveAfter

public void moveAfter(OdiLoadPlanStep pStepToMove,
                      OdiLoadPlanStep pAfterThisStep)

removeStep

public void removeStep(OdiLoadPlanStep pOdiLoadPlanStep)

duplicate

public OdiLoadPlanException duplicate()

getParentElement

public OdiLoadPlanElement getParentElement()

Specified by:

getParentElement in class OdiLoadPlanElement

Returns:

the parent element of the step in the hierarchy