oracle.odi.domain.runtime.lpi

Class OdiLoadPlanInstance

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.support.AbstractOdiEntity

oracle.odi.domain.runtime.lpi.OdiLoadPlanInstance

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IFlexFieldUser, oracle.odi.domain.impexp.IExportable, IOdiEntity, IRepositoryEntity, IWorkRuntimeOdiEntity

public class OdiLoadPlanInstance
extends oracle.odi.domain.support.AbstractOdiEntity
implements IWorkRuntimeOdiEntity, oracle.odi.domain.impexp.IExportable, IFlexFieldUser

The OdiLoadPlanInstance represents the state of an OdiLoadPlan once it's started.
Its main use is to keep an history of a load plan start, in order to be able to restart it in the same state.

This object is created and persisted in the repository by the code generation process and it's for consultation only.

Since:

11.1.1.5.0

See Also:

OdiLoadPlanInstanceStep, OdiLoadPlanInstanceVariable, OdiLoadPlanInstanceException, IOdiEntityManager, IOdiEntity, Serialized Form

Field Summary

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

STARTING_INTERNAL_VERSION

Method Summary

Modifier and Type	Method and Description
CecBehavior	getCecLprBehavior()
java.lang.Number	getCecLprPollIntv()
OdiContext	getContext()
java.lang.String	getDescription()
java.util.List	getExceptions()
java.util.Collection	getFlexFieldsValues() Obtains flex fields values related to this IFlexFieldUser.
OdiLoadPlanInstanceRun	getInstanceRun(java.lang.Long nbRun)
java.io.Serializable	getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
OdiLoadPlanInstanceStepLog	getLastActualSuccessStepLog(OdiLoadPlanInstanceStep pStep)
java.lang.Long	getLastRunCount()
OdiLoadPlan	getLoadPlan()
java.lang.Number	getLoadPlanId() Get the load plan id.
java.lang.Number	getLoadPlanInstanceId()
int	getLogHistoryRetainedNbDays()
OdiLogicalAgent	getLogicalAgent()
java.lang.Number	getMaxCecLpr()
java.lang.String	getName() Returns the name of this entity instance.
OdiLoadPlanInstanceStepSerial	getRootStep()
java.util.Collection	getRuns()
java.lang.String	getSessionKeywordsAsString()
OdiLoadPlan.SessionLogsBehavior	getSessionLogsDefaultBehaviorForScenarios() Indicates how logs will be maintained by default for the sessions of each of the scenarios started by the OdiLoadPlanInstance.
OdiLoadPlan.SessionStepLogsBehavior	getSessionLogsDefaultBehaviorForScenarioSteps() Indicates how logs will be maintained by default for the session steps of each of the scenarios started by the Load Plan instance.
int	getTaskLogLevel()
java.util.List	getVariables()
void	initFlexFields(IOdiFlexFieldFinder odiFlexFieldFinder) Initialize flex fields related to this IFlexFieldUser.
void	setCecLprBehavior(CecBehavior cecLprBehavior) Set the CecBehavior of this load plan instance that applies when getMaxCecLpr() returns a positive value.
void	setCecLprPollIntv(java.lang.Number cecLprPollIntv) Set the polling interval (in seconds) that applies when getMaxCecLpr() returns a positive value and getCecLprBehavior() is WAIT.
void	setContext(OdiContext context)
void	setLogicalAgent(OdiLogicalAgent logicalAgent)
void	setMaxCecLpr(java.lang.Number maxCecLpr) Set the maximum number of allowed concurrent load plan runs for this Load Plan Instance.

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

getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, 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.IOdiEntity

getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Method Detail

getLoadPlanId

public java.lang.Number getLoadPlanId()

Get the load plan id. This is useful in cases where the load plan itself has been deleted.

Returns:

the load plan id.

getLoadPlan

public OdiLoadPlan getLoadPlan()

Returns:

the load plan in which the OdiLoadPlanInstance is defined.

See Also:

OdiLoadPlan

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.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

getFlexFieldsValues

public java.util.Collection getFlexFieldsValues()

Description copied from interface: IFlexFieldUser

Obtains flex fields values related to this IFlexFieldUser. In most implementations method IFlexFieldUser.initFlexFields(IOdiFlexFieldFinder) should be called before calling this method.

Specified by:

getFlexFieldsValues in interface IFlexFieldUser

Returns:

an unmodifiable Collection of flex field values

initFlexFields

public void initFlexFields(IOdiFlexFieldFinder odiFlexFieldFinder)

Description copied from interface: IFlexFieldUser

Initialize flex fields related to this IFlexFieldUser.

Specified by:

initFlexFields in interface IFlexFieldUser

Parameters:

odiFlexFieldFinder - OdiFlexField finder to be used to query flex fields

getRootStep

public OdiLoadPlanInstanceStepSerial getRootStep()

Returns:

the OdiLoadPlanInstanceStep defined as root for this OdiLoadPlanInstance. Creates a root OdiLoadPlanInstanceStepSerial.

See Also:

initializeRootStep()

getLoadPlanInstanceId

public java.lang.Number getLoadPlanInstanceId()

Returns:

the unique id of this OdiLoadPlanInstance

getName

public java.lang.String getName()

Description copied from interface: IOdiEntity

Returns the name of this entity instance.

Specified by:

getName in interface IFlexFieldUser

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

the name of the OdiLoadPlanInstance

getSessionKeywordsAsString

public java.lang.String getSessionKeywordsAsString()

Returns:

Comma separated list of keywords to propagate to the sessions.

getSessionLogsDefaultBehaviorForScenarios

public OdiLoadPlan.SessionLogsBehavior getSessionLogsDefaultBehaviorForScenarios()

Indicates how logs will be maintained by default for the sessions of each of the scenarios started by the OdiLoadPlanInstance.

Returns:

the default behavior for logs for scenarios

See Also:

OdiLoadPlan.SessionLogsBehavior

getSessionLogsDefaultBehaviorForScenarioSteps

public OdiLoadPlan.SessionStepLogsBehavior getSessionLogsDefaultBehaviorForScenarioSteps()

Indicates how logs will be maintained by default for the session steps of each of the scenarios started by the Load Plan instance.

Returns:

the default behavior for the session steps

See Also:

OdiLoadPlan.SessionLogsBehavior

getLogHistoryRetainedNbDays

public int getLogHistoryRetainedNbDays()

Returns:

Number of days for which log history will be kept for this OdiLoadPlanInstance.

getTaskLogLevel

public int getTaskLogLevel()

Returns:

the task level logging (1..5).
Note: When OdiLoadPlanInstanceStepRunScenario are configured as RestartType = RUN_SCENARIO_FROM_STEP or RUN_SCENARIO_FROM_TASK, this property is ignored.

getDescription

public java.lang.String getDescription()

Returns:

the description of the OdiLoadPlanInstance

getExceptions

public java.util.List getExceptions()

Returns:

the unmodifiable list of OdiLoadPlanInstanceException defined for this OdiLoadPlanInstance

getContext

public OdiContext getContext()

Returns:

Forced Context that will be used to execute this Step.

See Also:

setContext(OdiContext), OdiContext

setContext

public void setContext(OdiContext context)

Parameters:

context - Forced Context that will be used to execute this Step.

See Also:

getContext(), OdiContext

getLogicalAgent

public OdiLogicalAgent getLogicalAgent()

Returns:

Forced logical agent in charge of executing this Step.

See Also:

setLogicalAgent(OdiLogicalAgent), OdiLogicalAgent

setLogicalAgent

public void setLogicalAgent(OdiLogicalAgent logicalAgent)

Parameters:

logicalAgent - Forced logical agent in charge of executing this Step.

See Also:

getLogicalAgent(), OdiLogicalAgent

getVariables

public java.util.List getVariables()

Returns:

the unmodifiable list of OdiLoadPlanInstanceVariables defined for this OdiLoadPlanInstance

getRuns

public java.util.Collection getRuns()

Returns:

the unmodifiable collection of runs for this OdiLoadPlanInstance

getInstanceRun

public OdiLoadPlanInstanceRun getInstanceRun(java.lang.Long nbRun)

Returns:

the unmodifiable collection of runs for this OdiLoadPlanInstance

getLastRunCount

public java.lang.Long getLastRunCount()

Returns:

the largest RunCount

getLastActualSuccessStepLog

public OdiLoadPlanInstanceStepLog getLastActualSuccessStepLog(OdiLoadPlanInstanceStep pStep)

Returns:

the steplog corresponding to the last time the Instance Step was successfully executed or null if the step was never successfully executed for this instance.

getMaxCecLpr

public java.lang.Number getMaxCecLpr()

Returns:

the maximum number of allowed concurrent load plan runs for this load plan instance. If null or <= 0 then concurrent execution control is not enabled.< dd>

setMaxCecLpr

public void setMaxCecLpr(java.lang.Number maxCecLpr)

Set the maximum number of allowed concurrent load plan runs for this Load Plan Instance. Since: 12.1.3 If null or <= 0 1 then concurrent execution control is not enabled. any value greater than or equal to enables the feature limit executions. when enabled, odi limits maximum regardless of numeric for this parameter.< div>

Parameters:

maxCecLpr -

getCecLprBehavior

public CecBehavior getCecLprBehavior()

Returns:

the CecBehavior of this load plan instance that applies when getMaxCecLpr() returns a positive value.

setCecLprBehavior

public void setCecLprBehavior(CecBehavior cecLprBehavior)

Set the CecBehavior of this load plan instance that applies when getMaxCecLpr() returns a positive value.

getCecLprPollIntv

public java.lang.Number getCecLprPollIntv()

Returns:

the polling interval (in seconds) that applies when getMaxCecLpr() returns a positive value and getCecLprBehavior() is WAIT.

setCecLprPollIntv

public void setCecLprPollIntv(java.lang.Number cecLprPollIntv)

Set the polling interval (in seconds) that applies when getMaxCecLpr() returns a positive value and getCecLprBehavior() is WAIT.