Skip navigation links

oracle.odi.domain.runtime.session
Class OdiSessionStepLog

java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.runtime.session.OdiSessionStepLog

All Implemented Interfaces:

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

public final class OdiSessionStepLog

extends oracle.odi.domain.support.AbstractRepositoryEntity

Execution log of an OdiSession's step. A step is the unit of execution found between a task and a session. It corresponds to a step in a package or in a scenario. When executing an interface or a single variable, for example, a session has only one session step. It is part of the OdiSession - OdiSessionVariable - OdiSessionStepLog aggregate. However, it is also root of the OdiSessionStepLog - OdiSessionTaskLog aggregate.

An OdiSessionStepLog life cycle begins when an ODI session step is runned by ODI Execution Engine. Its life cycle ends when enclosing @link OdiSession} is removed from runtime repository.

Since:

11.1.1.3.0

See Also:

Serialized Form

Method Summary

java.lang.String	getContextCode() Returns the context code of the OdiSessionStepLog.
java.lang.Integer	getDeleteCount() Returns the number of processed deletes, or null if not applicable.
java.lang.Integer	getDuration() Returns the duration (in second) of this step's execution, or null if not yet defined.
java.util.Date	getEndTime() Returns the end time for this step, or null if not yet finished.
java.lang.Integer	getErrorCount() Obtains the number of errors for this step.
java.lang.String	getErrorMessage() Returns the error message for this step if any.
int	getExecutionCount() Returns the internal count of execution of this same OdiSessionStepLog within the session execution.
int	getExecutionOrder() Reruns the order of execution of this step within the OdiSession.
int	getFailureRetryDelay() Returns the retry interval in seconds.
int	getFailureRetryNumber() Returns the indicator for retrying the step execution if an error occurred: 0 = Do not retry 1 = Retry.
OdiTrackedSequenceValue	getFirstTrackedSequenceValue(OdiSessionSequence pSequence) Convenient method to obtain first tracked occurrence of a given OdiSessionSequence in OdiSessionTaskLogs belonging this step execution.
java.lang.Integer	getInsertCount() Returns the number of processed inserts, or null if not applicable.
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.lang.String	getKoExitCode() Returns the Exit Code on failure.
OdiTrackedSequenceValue	getLastTrackedSequenceValue(OdiSessionSequence pSequence) Convenient method to obtain last tracked occurrence of a given OdiSessionSequence in OdiSessionTaskLogs belonging this step execution.
java.lang.Integer	getMaxErrorCount() Returns the maximum number of records allowed to be in error.
java.lang.String	getName() Returns the name of this OdiSessionStepLog.
OdiSessionStepLog	getNextStepAfterFailure() Retrieves the execution log of the step that has to be executed after one related to this OdiSessionStepLog, if it failed.
OdiSessionStepLog	getNextStepAfterSuccess() Retrieves the execution log of the step that has to be executed after one related to this OdiSessionStepLog, if it succeeds.
java.lang.String	getOkExitCode() Returns the Exit Code on success.
java.lang.Integer	getRecordCount() Returns overall number of records processed by this step, or null if not applicable.
java.lang.String	getReturnCode() Obtains the return code for this step.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
OdiSession	getSession() Returns the enclosing session execution.
java.lang.Number	getSessionId() Deprecated. As of 11.1.1.5 this method is replaced by getSession()
java.util.List<OdiSessionTaskLog>	getSessionTaskLogs() Obtains ordered unmodifiable list of task logs (OdiSessionTaskLog) that belong to this OdiSessionStepLog.
java.util.Date	getStartTime() Returns the start time for this step, or null if not yet started.
Status	getStatus() Obtains the current status of this step execution.
int	getStepNumber() Returns the internally calculated sequence number of this OdiSessionStepLog within the initial package.
StepType	getStepType() Returns the type of this OdiSessionStepLog.
java.lang.String	getTargetLogicalSchemaName() Obtains target logical schema name on which this step's tasks are executed.
java.lang.String	getTargetModelCode() Obtains target model code on which this step's tasks are executed.
java.lang.String	getTargetResourceName() Obtains target resource name (i.e.
java.lang.String	getTargetTableName() Obtains target table name on which this step's tasks are executed.
java.util.Collection<OdiTrackedVariableValue>	getTrackedVariableValues() Obtains the tracked values of session's variables for this step execution.
java.lang.Integer	getUpdateCount() Returns overall number of updates processed by this step, or null if not applicable.
java.lang.Number	getVariableIncrement() Returns the variable increment.
java.lang.String	getVariableName() Returns the variable name.
VariableOperator	getVariableOperator() Returns the operator for variable evaluation.
java.lang.String	getVariableValue() Returns the value or list of value with separator.
boolean	isContextForced() Returns whether context for this step execution was forced to a different context than the enclosing session execution's context, or not.
boolean	isKoExit() Returns true if exit required on failure, false - otherwise.
boolean	isMaxErrorCountAsPercentage() Returns whether the "maxErrorCount" property indicates a number of error or a percentage of error.
boolean	isOkExit() Returns true if exit required on success, false - otherwise.
boolean	isTrackingEnabled() Returns whether variable and sequence value tracking is enabled for this OdiSessionStepLog.
void	setMaxErrorCount(java.lang.Integer pMaxErrorCount) Set the maximum number of records allowed to be in error.
void	setMaxErrorCountAsPercentage(boolean pMaxErrorCountAsPercentage) Defines whether "maxErrorCount" indicates a number or a percentage of error.
void	setStatus(Status pStatus) Set the current status of this step execution.

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

clone

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSessionTaskLogs

public java.util.List<OdiSessionTaskLog> getSessionTaskLogs()

Obtains ordered unmodifiable list of task logs (OdiSessionTaskLog) that belong to this OdiSessionStepLog.

Returns:

list of session's task logs

getContextCode

public java.lang.String getContextCode()

Returns the context code of the OdiSessionStepLog. Maybe the execution context, or a forced context for this step.

Returns:

context code

getDeleteCount

public java.lang.Integer getDeleteCount()

Returns the number of processed deletes, or null if not applicable.

Relevant for Interfaces and Procedures and any execution that manipulates data.

Returns:

the number of processed deletes

getDuration

public java.lang.Integer getDuration()

Returns the duration (in second) of this step's execution, or null if not yet defined.

Returns:

the duration (in second) of this step's execution

getEndTime

public java.util.Date getEndTime()

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

Returns:

step end time

getErrorCount

public java.lang.Integer getErrorCount()

Obtains the number of errors for this step.

Returns:

number of errors

getErrorMessage

public java.lang.String getErrorMessage()

Returns the error message for this step if any. Will always return null if not failed.

Returns:

error message

getExecutionCount

public int getExecutionCount()

Returns the internal count of execution of this same OdiSessionStepLog within the session execution.

Returns:

step execution count

isContextForced

public boolean isContextForced()

Returns whether context for this step execution was forced to a different context than the enclosing session execution's context, or not.

Returns:

true if context was forced, false otherwise

getInsertCount

public java.lang.Integer getInsertCount()

Returns the number of processed inserts, or null if not applicable.

Relevant for Interfaces and Procedures and any execution that manipulates data.

Returns:

the number of processed inserts

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

getName

public java.lang.String getName()

Returns the name of this OdiSessionStepLog. This name matches the name of the step as defined in the package that has generated the scenario otherwise it matches the name of the executed object such as OdiInterface, OdiVariable, OdiProcedure etc.

Returns:

step name

getRecordCount

public java.lang.Integer getRecordCount()

Returns overall number of records processed by this step, or null if not applicable.

Relevant for Interfaces and Procedures and any execution that manipulates data.

Returns:

overall number of records processed by this step

getReturnCode

public java.lang.String getReturnCode()

Obtains the return code for this step. The return code is obtained from the execution channel of the last task, e.g. operating system code, database error code, etc. It will be "0" (zero) in case of success.

Returns:

step return code

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Returns:

container entity

getStartTime

public java.util.Date getStartTime()

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

Returns:

start time

getStatus

public Status getStatus()

Obtains the current status of this step execution.

Returns:

step status

See Also:

setStatus(Status)

setStatus

public void setStatus(Status pStatus)

Set the current status of this step execution.

Parameters:

pStatus - the status

Since:

11.1.1.5.0

See Also:

getStatus()

getStepNumber

public int getStepNumber()

Returns the internally calculated sequence number of this OdiSessionStepLog within the initial package.

Returns:

sequence number of this OdiSessionStepLog within the initial package

getStepType

public StepType getStepType()

Returns the type of this OdiSessionStepLog.

Returns:

step type

getTargetLogicalSchemaName

public java.lang.String getTargetLogicalSchemaName()

Obtains target logical schema name on which this step's tasks are executed.

Returns:

logical schema name

getTargetModelCode

public java.lang.String getTargetModelCode()

Obtains target model code on which this step's tasks are executed.

Returns:

model code

getTargetResourceName

public java.lang.String getTargetResourceName()

Obtains target resource name (i.e. physical name of the table or underlying resource) on which this step's tasks are executed.

Returns:

the resource name

getTargetTableName

public java.lang.String getTargetTableName()

Obtains target table name on which this step's tasks are executed.

Returns:

the table name

getUpdateCount

public java.lang.Integer getUpdateCount()

Returns overall number of updates processed by this step, or null if not applicable.

Relevant for Interfaces and Procedures and any execution that manipulates data.

Returns:

overall number of updates processed by this step

isMaxErrorCountAsPercentage

public boolean isMaxErrorCountAsPercentage()

Returns whether the "maxErrorCount" property indicates a number of error or a percentage of error.

Returns:

true if percentage, false otherwise.

See Also:

getMaxErrorCount(), setMaxErrorCountAsPercentage(boolean)

setMaxErrorCountAsPercentage

public void setMaxErrorCountAsPercentage(boolean pMaxErrorCountAsPercentage)

Defines whether "maxErrorCount" indicates a number or a percentage of error.

Parameters:

pMaxErrorCountAsPercentage - true to indicate a percentage, false otherwise

Since:

11.1.1.5.0

See Also:

isMaxErrorCountAsPercentage(), setMaxErrorCount(java.lang.Integer)

getMaxErrorCount

public java.lang.Integer getMaxErrorCount()

Returns the maximum number of records allowed to be in error.

Returns:

the maximum number of errors

See Also:

setMaxErrorCount(Integer), isMaxErrorCountAsPercentage()

setMaxErrorCount

public void setMaxErrorCount(java.lang.Integer pMaxErrorCount)

Set the maximum number of records allowed to be in error.

Parameters:

pMaxErrorCount - the maximum of errors

Since:

11.1.1.5.0

See Also:

getMaxErrorCount(), setMaxErrorCountAsPercentage(boolean)

getSessionId

public java.lang.Number getSessionId()

Deprecated. As of 11.1.1.5 this method is replaced by getSession()

Returns the ID of OdiSession this OdiSessionStepLog is related to.

Returns:

session ID

getNextStepAfterFailure

public OdiSessionStepLog getNextStepAfterFailure()

Retrieves the execution log of the step that has to be executed after one related to this OdiSessionStepLog, if it failed.

If no next OdiSessionStepLog was defined (null is defined), the execution will stop after failure.

Returns:

the next step after failure or null is none

getNextStepAfterSuccess

public OdiSessionStepLog getNextStepAfterSuccess()

Retrieves the execution log of the step that has to be executed after one related to this OdiSessionStepLog, if it succeeds.

If no next OdiSessionStepLog was defined (null is defined), the execution will stop after success.

Returns:

the execution log of the next step after success or null if none

getKoExitCode

public java.lang.String getKoExitCode()

Returns the Exit Code on failure.

Returns:

the Exit Code on failure

getOkExitCode

public java.lang.String getOkExitCode()

Returns the Exit Code on success.

Returns:

the Exit Code on success

isOkExit

public boolean isOkExit()

Returns true if exit required on success, false - otherwise.

Returns:

true if exit required on success, false - otherwise

isKoExit

public boolean isKoExit()

Returns true if exit required on failure, false - otherwise.

Returns:

true if exit required on failure, false - otherwise

getFailureRetryNumber

public int getFailureRetryNumber()

Returns the indicator for retrying the step execution if an error occurred: 0 = Do not retry 1 = Retry.

Returns:

the indicator for retrying the step execution if an error occurred

getFailureRetryDelay

public int getFailureRetryDelay()

Returns the retry interval in seconds.

Returns:

the retry interval in seconds

getVariableName

public java.lang.String getVariableName()

Returns the variable name.

Returns:

the variable name

getVariableValue

public java.lang.String getVariableValue()

Returns the value or list of value with separator.

These values are evaluated before the execution of the step

.

Returns:

the value or list of value with separator

getVariableIncrement

public java.lang.Number getVariableIncrement()

Returns the variable increment.

Returns:

the variable increment

getVariableOperator

public VariableOperator getVariableOperator()

Returns the operator for variable evaluation.

Returns:

the operator for variable evaluation

See Also:

link VariableOperator}

getExecutionOrder

public int getExecutionOrder()

Reruns the order of execution of this step within the OdiSession.

Returns:

the Execution Order

Since:

11.1.1.5.0

getTrackedVariableValues

public java.util.Collection<OdiTrackedVariableValue> getTrackedVariableValues()

Obtains the tracked values of session's variables for this step execution.

Returns:

Collection of OdiTrackedVariableValues that can be empty if no tracking has occurred, or if no variable is used by the enclosing OdiSession.

isTrackingEnabled

public boolean isTrackingEnabled()

Returns whether variable and sequence value tracking is enabled for this OdiSessionStepLog.

Returns:

true if tracking is enabled, false otherwise

getFirstTrackedSequenceValue

public OdiTrackedSequenceValue getFirstTrackedSequenceValue(OdiSessionSequence pSequence)

Convenient method to obtain first tracked occurrence of a given OdiSessionSequence in OdiSessionTaskLogs belonging this step execution. If there is no tracked value of the given sequence, or if tracking is disabled it will return null.

Parameters:

pSequence - a sequence

Returns:

an OdiTrackedSequenceValue or null

getLastTrackedSequenceValue

public OdiTrackedSequenceValue getLastTrackedSequenceValue(OdiSessionSequence pSequence)

Convenient method to obtain last tracked occurrence of a given OdiSessionSequence in OdiSessionTaskLogs belonging this step execution. If there is no tracked value of the given sequence, or if tracking is disabled it will return null.

Parameters:

pSequence - a sequence

Returns:

an OdiTrackedSequenceValue or null

getSession

public OdiSession getSession()

Returns the enclosing session execution.

Returns:

an OdiSession

Skip navigation links