Skip navigation links

oracle.odi.domain.runtime.session
Class OdiSessionTaskLog

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

All Implemented Interfaces:

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

public final class OdiSessionTaskLog

extends oracle.odi.domain.support.AbstractRepositoryEntity

Execution log of an OdiSession's task. The task is the smallest execution unit. It corresponds to a procedure command, assignment of a variable, etc. It is part of the OdiSessionStepLog - OdiSessionTaskLog aggregate.

An OdiSessionTaskLog life cycle begins when an ODI session's step is run by ODI Execution Engine. Its life cycle ends when enclosing OdiSessionStepLog (or OdiSession) is removed from runtime repository.

Since:

11.1.1.3.0

See Also:

Serialized Form

Nested Class Summary

static class	OdiSessionTaskLog.CommitMode Type safe enum that represents commit mode applied to a task when executed.
static class	OdiSessionTaskLog.IsolationLevel Type safe enum that represents DB isolation level applied to a task when executed.
static class	OdiSessionTaskLog.LogCounter Type safe enum that represents different log counter types defined for a task.
static class	OdiSessionTaskLog.ValueTrackingMode Type safe enum that represents OdiSessionVariable and OdiSessionSequence value tracking mode.

Method Summary

java.lang.Integer	getDeleteCount() Relevant for Interfaces and Procedures and any execution that manipulates data.
java.lang.Integer	getDuration() Returns duration of this OdiSessionTaskLog, or null if undefined.
java.util.Date	getEndTime() Returns end time of this OdiSessionTaskLog, or null if not yet finished.
java.lang.Integer	getErrorCount() Returns the error count.
java.lang.String	getErrorMessage() Returns error message of this OdiSessionTaskLog.
int	getExecutionCount() Deprecated. As of ODI 11.1.1.5 this method is not supported anymore and the executionCount of a task log must now be obtained from the enclosing OdiSessionStepLog since executionCount of a setp log and task log are the same
java.lang.Integer	getInsertCount() Relevant for Interfaces and Procedures and any execution that manipulates data.
java.io.Serializable	getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
int	getInternalOrder() Returns the internal order value.
OdiSessionTaskLog.LogCounter	getLogCounter() Returns LogCounter used by this OdiSessionTaskLog.
boolean	getLogFinalCommand() Returns whether the final execution command text should be logged for this OdiSessionTaskLog.
LogLevel	getLogLevel() Returns level of log details for this OdiSessionTaskLog.
java.lang.Integer	getRecordCount() Relevant for Interfaces and Procedures and any execution that manipulates data.
java.lang.String	getResolvedSourceCommand() Obtains the source command where variable and sequence substitutions (e.g.
java.lang.String	getResolvedTargetCommand() Obtains the target command where variable and sequence substitutions (e.g.
java.lang.String	getReturnCode() Returns return code of this OdiSessionTaskLog.
int	getScenarioTaskNumber() Returns the scenario task number.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
OdiSessionStepLog	getSessionStepLog() Obtains the enclosing step execution.
java.lang.String	getSourceCommand() Returns the actual command executed on source.
OdiSessionTaskLog.CommitMode	getSourceCommitMode() Returns transaction commit mode applied for source command, or null if undefined.
java.lang.String	getSourceContextCode() Returns forced context code for execution on source.
java.lang.String	getSourceDataServerName() Returns computed source data server name, or null if undefined.
OdiSessionTaskLog.IsolationLevel	getSourceIsolationLevel() Returns source isolation level, or null if undefined.
java.lang.String	getSourceLogicalSchemaName() Returns logical schema name on the source technology for the task.
java.lang.String	getSourceTransactionId() Returns source transaction ID, or null if undefined.
java.util.Date	getStartTime() Returns start time of this OdiSessionTaskLog, or null if not yet started.
Status	getStatus() Returns status of this OdiSessionTaskLog.
java.lang.String	getTargetCommand() Returns the actual command executed on target.
OdiSessionTaskLog.CommitMode	getTargetCommitMode() Returns transaction commit mode applied for target command, or null if undefined.
java.lang.String	getTargetContextCode() Returns forced context code for execution on target.
java.lang.String	getTargetDataServerName() Returns computed target data server name, or null if undefined.
OdiSessionTaskLog.IsolationLevel	getTargetIsolationLevel() Returns target isolation level, or null if undefined.
java.lang.String	getTargetLogicalSchemaName() Returns logical schema name on the target technology for the task.
java.lang.String	getTargetTransactionId() Returns target transaction ID, or null if undefined.
int	getTaskLogNumber() Deprecated. As of ODI 11.1.1.5 this method is not supported anymore and the taskLogNumber of a task log must now be obtained from the enclosing OdiSessionStepLog since stepNumber of a step log and taskLogNumber are the same
java.lang.String	getTaskName1() Gets task name 1 of this OdiSessionTaskLog, or null if undefined.
java.lang.String	getTaskName2() Gets task name 2 of this OdiSessionTaskLog, or null if undefined.
java.lang.String	getTaskName3() Gets task name 3 of this OdiSessionTaskLog, or null if undefined.
java.util.Collection<OdiTrackedSequenceValue>	getTrackedSequenceValues() Obtains the tracked values of session's sequences for this task execution.
TaskType	getType() Return the type of task.
java.lang.Integer	getUpdateCount() Relevant for Interfaces and Procedures and any execution that manipulates data.
OdiSessionTaskLog.ValueTrackingMode	getValueTrackingMode() Returns value tracking mode used for this task log.
boolean	isIgnoreError() Returns whether errors are ignored for this OdiSessionTaskLog.
void	setIgnoreError(boolean pIgnoreError) Set whether errors are ignored for this OdiSessionTaskLog.
void	setSourceCommand(java.lang.String pSourceCmd) Set the command to be executed on source.
void	setStatus(Status pStatus) Set the current status of this task execution.
void	setTargetCommand(java.lang.String pTargetCmd) Set the command to be executed on target.

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

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

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Returns:

container entity

getInternalOrder

public int getInternalOrder()

Returns the internal order value.

Returns:

internal order

getType

public TaskType getType()

Return the type of task.

Returns:

a TaskType

Since:

11.1.1.5.0

getTaskName1

public java.lang.String getTaskName1()

Gets task name 1 of this OdiSessionTaskLog, or null if undefined.

Returns:

task name 1 of this OdiSessionTaskLog, or null if undefined

getTaskName2

public java.lang.String getTaskName2()

Gets task name 2 of this OdiSessionTaskLog, or null if undefined.

Returns:

task name 2 of this OdiSessionTaskLog, or null if undefined

getTaskName3

public java.lang.String getTaskName3()

Gets task name 3 of this OdiSessionTaskLog, or null if undefined.

Returns:

task name 3 of this OdiSessionTaskLog, or null if undefined

getStartTime

public java.util.Date getStartTime()

Returns start time of this OdiSessionTaskLog, or null if not yet started.

Returns:

start time of this OdiSessionTaskLog, or null if not yet started

getEndTime

public java.util.Date getEndTime()

Returns end time of this OdiSessionTaskLog, or null if not yet finished.

Returns:

end time of this OdiSessionTaskLog, or null if not yet finished

getDuration

public java.lang.Integer getDuration()

Returns duration of this OdiSessionTaskLog, or null if undefined.

Returns:

duration of this OdiSessionTaskLog, or null if undefined

getStatus

public Status getStatus()

Returns status of this OdiSessionTaskLog.

Returns:

status of this OdiSessionTaskLog

See Also:

setStatus(Status)

setStatus

public void setStatus(Status pStatus)

Set the current status of this task execution.

Parameters:

pStatus - the status

Since:

11.1.1.5.0

See Also:

getStatus()

getReturnCode

public java.lang.String getReturnCode()

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

Returns:

return code of this OdiSessionTaskLog

getErrorMessage

public java.lang.String getErrorMessage()

Returns error message of this OdiSessionTaskLog. Will always be null if not failed.

Returns:

error message of this OdiSessionTaskLog. Will always be null if not failed

getLogCounter

public OdiSessionTaskLog.LogCounter getLogCounter()

Returns LogCounter used by this OdiSessionTaskLog.

Returns:

LogCounter used by this OdiSessionTaskLog

getInsertCount

public java.lang.Integer getInsertCount()

Relevant for Interfaces and Procedures and any execution that manipulates data. Returns the number of processed inserts, or null if not applicable.

Returns:

the number of processed inserts, or null if not applicable

getUpdateCount

public java.lang.Integer getUpdateCount()

Relevant for Interfaces and Procedures and any execution that manipulates data. Returns the number of processed updates, or null if not applicable.

Returns:

the number of processed updates, or null if not applicable

getDeleteCount

public java.lang.Integer getDeleteCount()

Relevant for Interfaces and Procedures and any execution that manipulates data. Returns the number of processed deletes, or null if not applicable.

Returns:

the number of processed deletes, or null if not applicable

getRecordCount

public java.lang.Integer getRecordCount()

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

Returns:

the overall number of processed records, or null if not applicable

Since:

11.1.1.5.0

getErrorCount

public java.lang.Integer getErrorCount()

Returns the error count.

Returns:

the error count

getSourceContextCode

public java.lang.String getSourceContextCode()

Returns forced context code for execution on source. If null, context defined for session is used.

Returns:

forced context code for execution on source. If null, context defined for session is used

getSourceLogicalSchemaName

public java.lang.String getSourceLogicalSchemaName()

Returns logical schema name on the source technology for the task.

Returns:

logical schema name on the source technology for the task

getSourceDataServerName

public java.lang.String getSourceDataServerName()

Returns computed source data server name, or null if undefined.

Returns:

computed source data server name, or null if undefined

getSourceTransactionId

public java.lang.String getSourceTransactionId()

Returns source transaction ID, or null if undefined.

Returns:

source transaction ID, or null if undefined

getSourceIsolationLevel

public OdiSessionTaskLog.IsolationLevel getSourceIsolationLevel()

Returns source isolation level, or null if undefined.

Returns:

source isolation level, or null if undefined

getSourceCommitMode

public OdiSessionTaskLog.CommitMode getSourceCommitMode()

Returns transaction commit mode applied for source command, or null if undefined.

Returns:

transaction commit mode applied for source command, or null if undefined

getSourceCommand

public java.lang.String getSourceCommand()

Returns the actual command executed on source.

Returns:

a String representing the source command, or null if undefined

See Also:

setSourceCommand(String)

setSourceCommand

public void setSourceCommand(java.lang.String pSourceCmd)

Set the command to be executed on source.

Parameters:

pSourceCmd - the source command

Since:

11.1.1.5.0

See Also:

getSourceCommand()

getTargetContextCode

public java.lang.String getTargetContextCode()

Returns forced context code for execution on target. If null, context defined for session is used.

Returns:

forced context code for execution on target. If null, context defined for session is used

getTargetLogicalSchemaName

public java.lang.String getTargetLogicalSchemaName()

Returns logical schema name on the target technology for the task.

Returns:

logical schema name on the target technology for the task

getTargetDataServerName

public java.lang.String getTargetDataServerName()

Returns computed target data server name, or null if undefined.

Returns:

computed target data server name, or null if undefined

getTargetTransactionId

public java.lang.String getTargetTransactionId()

Returns target transaction ID, or null if undefined.

Returns:

target transaction ID, or null if undefined

getTargetIsolationLevel

public OdiSessionTaskLog.IsolationLevel getTargetIsolationLevel()

Returns target isolation level, or null if undefined.

Returns:

target isolation level, or null if undefined

getTargetCommitMode

public OdiSessionTaskLog.CommitMode getTargetCommitMode()

Returns transaction commit mode applied for target command, or null if undefined.

Returns:

transaction commit mode applied for target command, or null if undefined

getTargetCommand

public java.lang.String getTargetCommand()

Returns the actual command executed on target.

Returns:

a String representing the target command, or null if undefined

See Also:

setTargetCommand(String)

setTargetCommand

public void setTargetCommand(java.lang.String pTargetCmd)

Set the command to be executed on target.

Parameters:

pTargetCmd - the target command

Since:

11.1.1.5.0

See Also:

getTargetCommand()

getScenarioTaskNumber

public int getScenarioTaskNumber()

Returns the scenario task number.

Returns:

the scenario task number

getExecutionCount

public int getExecutionCount()

Deprecated. As of ODI 11.1.1.5 this method is not supported anymore and the executionCount of a task log must now be obtained from the enclosing OdiSessionStepLog since executionCount of a setp log and task log are the same

Returns the count of executions for this OdiSessionTaskLog.

Returns:

the count of executions for this OdiSessionTaskLog

getTaskLogNumber

public int getTaskLogNumber()

Deprecated. As of ODI 11.1.1.5 this method is not supported anymore and the taskLogNumber of a task log must now be obtained from the enclosing OdiSessionStepLog since stepNumber of a step log and taskLogNumber are the same

Returns the OdiSessionTaskLog's number.

Returns:

the OdiSessionTaskLog's number

getLogLevel

public LogLevel getLogLevel()

Returns level of log details for this OdiSessionTaskLog.

Returns:

level of log details for this OdiSessionTaskLog

isIgnoreError

public boolean isIgnoreError()

Returns whether errors are ignored for this OdiSessionTaskLog.

Returns:

true if errors are ignored, false otherwise

See Also:

setIgnoreError(boolean)

setIgnoreError

public void setIgnoreError(boolean pIgnoreError)

Set whether errors are ignored for this OdiSessionTaskLog.

Parameters:

pIgnoreError - true to ignore errors, false otherwise

Since:

11.1.1.5.0

See Also:

isIgnoreError()

getLogFinalCommand

public boolean getLogFinalCommand()

Returns whether the final execution command text should be logged for this OdiSessionTaskLog.

Returns:

true if final command text should be logged, false otherwise.

Since:

11.1.1.6.0

See Also:

OdiProcedureLine.getLogFinalCommand(), OdiProcedureLine.setLogFinalCommand(boolean)

getSessionStepLog

public OdiSessionStepLog getSessionStepLog()

Obtains the enclosing step execution.

Returns:

an OdiSessionStepLog

getResolvedSourceCommand

public java.lang.String getResolvedSourceCommand()

Obtains the source command where variable and sequence substitutions (e.g. #VAR_NAME and #SEQ_NAME_NEXTVAL respectively) have been replaced with their relevant values (i.e. initial value) tracked during this task execution. If tracking is disabled, the source command string is returned as is.

Beware, this method is only relevant for debug purpose and must not be used during session execution as the actual task command to be executed.

Returns:

the resolved command string according to the current variable tracking status

See Also:

getSourceCommand(), OdiSessionStepLog.getTrackedVariableValues()

getResolvedTargetCommand

public java.lang.String getResolvedTargetCommand()

Obtains the target command where variable and sequence substitutions (e.g. #VAR_NAME and #SEQ_NAME_NEXTVAL respectively) have been replaced with their relevant values (i.e. initial value) tracked during this task execution. If tracking is disabled, the target command string is returned as is.

Beware, this method is only relevant for debug purpose and must not be used during session execution as the actual task command to be executed.

Returns:

the resolved command string according to the current variable tracking status

See Also:

getTargetCommand(), OdiSessionStepLog.getTrackedVariableValues()

getTrackedSequenceValues

public java.util.Collection<OdiTrackedSequenceValue> getTrackedSequenceValues()

Obtains the tracked values of session's sequences for this task execution.

Returns:

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

See Also:

OdiSessionStepLog.isTrackingEnabled(), OdiSessionStepLog#getTrackedSequenceValues()

getValueTrackingMode

public OdiSessionTaskLog.ValueTrackingMode getValueTrackingMode()

Returns value tracking mode used for this task log.

Returns:

a ValueTrackingMode

Skip navigation links