oracle.odi.domain.runtime.lpi

Class OdiLoadPlanInstanceStep

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.runtime.lpi.OdiLoadPlanInstanceElement

oracle.odi.domain.runtime.lpi.OdiLoadPlanInstanceStep

All Implemented Interfaces:

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

Direct Known Subclasses:

OdiLoadPlanInstanceStepCase, OdiLoadPlanInstanceStepContainer, OdiLoadPlanInstanceStepRunScenario

public abstract class OdiLoadPlanInstanceStep
extends OdiLoadPlanInstanceElement

This class represents the OdiLoadPlanStep class in the OdiLoadPlanInstance hierarchy

.

It only offers consultation methods.

Since:

11.1.1.5.0

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.odi.domain.runtime.lpi.OdiLoadPlanInstanceElement

NAME_MAX_LENGTH

Constructor Summary

Constructors

Constructor and Description
OdiLoadPlanInstanceStep()

Method Summary

Methods

Modifier and Type	Method and Description
OdiLoadPlanStep.ExceptionBehavior	getExceptionBehavior()
OdiLoadPlanInstanceException	getExceptionStep()
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	getLoadPlanInstanceStepVariables()
OdiLoadPlanInstanceStepLog	getLog(OdiLoadPlanInstanceRun instanceRun)
int	getOrder()
OdiLoadPlanInstanceElement	getParentLoadPlanInstanceElement()
java.lang.String	getSessionKeywordsAsString()
int	getTimeout()
boolean	isEnabled()

Methods inherited from class oracle.odi.domain.runtime.lpi.OdiLoadPlanInstanceElement

getName, getSecurityContainer, getStepId

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

equals, getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, hashCode, invokeCustomizedPersistenceMethodFor, toString

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OdiLoadPlanInstanceStep

public OdiLoadPlanInstanceStep()

Method Detail

getLoadPlanInstanceStepVariables

public java.util.Collection getLoadPlanInstanceStepVariables()

Returns:

the unmodifiable collection of OdiLoadPlanInstanceStepVariable

getLog

public OdiLoadPlanInstanceStepLog getLog(OdiLoadPlanInstanceRun instanceRun)

getSessionKeywordsAsString

public java.lang.String getSessionKeywordsAsString()

Returns:

Keywords for sessions created when executing this OdiLoadPlanInstanceException

getExceptionBehavior

public OdiLoadPlanStep.ExceptionBehavior getExceptionBehavior()

Returns:

Exception behavior specifies how this step should behave in case an exception is encountered.

isEnabled

public boolean isEnabled()

Returns:

0/1 to enable or disable this exception. Disabled steps are not executed in the overall load plan instance regardless of the enabled/disabled property of their sub-elements.

getOrder

public int getOrder()

Returns:

Defines the order of this step within its parent step. When the parent step is a serial step, the order defines the execution order.

See Also:

OdiLoadPlanInstanceStepSerial

getTimeout

public int getTimeout()

Returns:

Timeout in seconds for this step. The timeout defines a maximum time that this step should take before being aborted by the Load Plan instance. A value of zero indicates an infinite timeout.
. When a timeout is reached, the step is marked in error and the Exception associated is launched.

getExceptionStep

public OdiLoadPlanInstanceException getExceptionStep()

Returns:

the exception step defined within this load plan instance to be executed in case this step is in Error.

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

getParentLoadPlanInstanceElement

public OdiLoadPlanInstanceElement getParentLoadPlanInstanceElement()

Returns:

the parent element of the step in the hierarchy