oracle.odi.domain.runtime.lpi

Class OdiLoadPlanInstanceRun

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.support.AbstractOdiEntity

oracle.odi.domain.runtime.lpi.OdiLoadPlanInstanceRun

All Implemented Interfaces:

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

public class OdiLoadPlanInstanceRun
extends oracle.odi.domain.support.AbstractOdiEntity

Class representing the attempt to execute an OdiLoadPlanInstance

Since:

11.1.1.5.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OdiLoadPlanInstanceRun.OdiLoadPlanInstanceRunId Implements the composite key for OdiContextualSchemaMapping.
static class	OdiLoadPlanInstanceRun.Status Execution status
static class	OdiLoadPlanInstanceRun.StepCaseConditionStatus Case step clause Evaluation status

Field Summary

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity

STARTING_INTERNAL_VERSION

Method Summary

Modifier and Type	Method and Description
OdiLoadPlanInstanceRun.StepCaseConditionStatus	getConditionStatus(OdiLoadPlanInstanceCaseCondition pCaseCondition)
OdiContext	getContext()
java.lang.Number	getDuration() Deprecated. as the duration is no more populated by runtime. Use getEndTime-getStartTime to get the duration
java.util.Date	getEndTime()
java.lang.String	getErrorMessage()
java.lang.Long	getEssJobId() Returns the ID of ESS Job which started this OdiLoadPlanInstance.
java.lang.Long	getEssRequestExecutionContext() Returns the RequestExecutionContext of ESS Job which started this OdiLoadPlanInstance.
ExecutionMode	getExecutionMode() Returns execution mode of this OdiLoadPlanInstanceRun that will be used to launch an OdiScenario.
java.io.Serializable	getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
OdiLoadPlanInstance	getLoadPlanInstance()
OdiLoadPlanInstanceStepLog	getLog(OdiLoadPlanInstanceStep pStep)
OdiLoadPlanInstanceExceptionLog	getLogForExceptionStep(OdiLoadPlanInstanceStep parentStep, OdiLoadPlanInstanceStep exceptionStep)
java.lang.String	getPhysicalAgentName()
java.lang.String	getReturnCode()
java.lang.Long	getRunCount()
java.util.Date	getStartTime()
OdiLoadPlanInstanceRun.Status	getStatus()
java.lang.String	getStatusCode(OdiLoadPlanInstanceRun.Status status)
java.lang.String	getUserName()
boolean	isEssJobLoadPlanInstance() Returns true if this OdiLoadPlanInstance was started by ESS Job, false otherwise.

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

getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, getName, isInstanceLevelSecurityNeeded, isNew, preCommit, 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

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Method Detail

getExecutionMode

public ExecutionMode getExecutionMode()

Returns execution mode of this OdiLoadPlanInstanceRun that will be used to launch an OdiScenario.

Returns:

an ExecutionMode

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

getLog

public OdiLoadPlanInstanceStepLog getLog(OdiLoadPlanInstanceStep pStep)

Parameters:

pStep -

Returns:

the log associated to a step of the current run

getLogForExceptionStep

public OdiLoadPlanInstanceExceptionLog getLogForExceptionStep(OdiLoadPlanInstanceStep parentStep,
                                                              OdiLoadPlanInstanceStep exceptionStep)

getStartTime

public java.util.Date getStartTime()

Returns:

the start time for this run, or null if not yet started.

getEndTime

public java.util.Date getEndTime()

Returns:

the end time for this run, or null if not yet finished.

getDuration

@Deprecated
public java.lang.Number getDuration()

Deprecated. as the duration is no more populated by runtime. Use getEndTime-getStartTime to get the duration

getStatus

public OdiLoadPlanInstanceRun.Status getStatus()

Returns:

the Execution status, as an enum value

getStatusCode

public java.lang.String getStatusCode(OdiLoadPlanInstanceRun.Status status)

Returns:

Execution status code, a one-letter string, "D" for Done, "E" for Error...

getErrorMessage

public java.lang.String getErrorMessage()

Returns:

Return the error message for this run if any. Will always return null if not failed.

getReturnCode

public java.lang.String getReturnCode()

Returns:

Return code associated to this run or null if not defined yet

getUserName

public java.lang.String getUserName()

Returns:

the name of the ODI user that initiated this run

getContext

public OdiContext getContext()

Returns:

Forced Context that will be used to execute this Step.

See Also:

#setOptimizationContext(OdiContext), OdiContext

getPhysicalAgentName

public java.lang.String getPhysicalAgentName()

Returns:

Default physical agent name used for the whole load plan instance

getLoadPlanInstance

public OdiLoadPlanInstance getLoadPlanInstance()

Returns:

the instance to which this run is associated

getConditionStatus

public OdiLoadPlanInstanceRun.StepCaseConditionStatus getConditionStatus(OdiLoadPlanInstanceCaseCondition pCaseCondition)

Parameters:

pCaseCondition -

Returns:

the result of the evaluation of a OdiLoadPlanInstanceCaseCondition in the current run

getRunCount

public java.lang.Long getRunCount()

Returns:

Number of attempts (Restarts) to run this Load Plan Instance

getEssJobId

public java.lang.Long getEssJobId()

Returns the ID of ESS Job which started this OdiLoadPlanInstance.

Returns:

the ID of ESS Job which started this OdiLoadPlanInstance

Throws:

java.lang.IllegalStateException - if this OdiLoadPlanInstance is not ESS Job related

getEssRequestExecutionContext

public java.lang.Long getEssRequestExecutionContext()

Returns the RequestExecutionContext of ESS Job which started this OdiLoadPlanInstance.

Returns:

the RequestExecutionContext of ESS Job which started this OdiLoadPlanInstance

Throws:

java.lang.IllegalStateException - if this OdiLoadPlanInstance is not ESS Job related

isEssJobLoadPlanInstance

public boolean isEssJobLoadPlanInstance()

Returns true if this OdiLoadPlanInstance was started by ESS Job, false otherwise.

Returns:

true if this OdiLoadPlanInstance was started by ESS Job, false otherwise