Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.3.0)

E17060-01

oracle.odi.domain.runtime.session
Class OdiSessionTaskLog

java.lang.Object
  extended by oracle.odi.domain.support.BusinessObject
      extended by oracle.odi.domain.support.AbstractRepositoryEntity
          extended by 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 runned 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.
 
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()
          Returns the count of executions for this OdiSessionTaskLog.
 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.
 LogLevel getLogLevel()
          Returns level of log details for this OdiSessionTaskLog.
 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.
 java.lang.String getSourceCommand()
          Returns the actual command executed on source, or null if undefined.
 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, or null if undefined.
 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()
          Returns the OdiSessionTaskLog's number.
 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.lang.Integer getUpdateCount()
          Relevant for Interfaces and Procedures and any execution that manipulates data.
 boolean isIgnoreError()
          Returns whether errors are ignored for this OdiSessionTaskLog.
 
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

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

getDuration

public java.lang.Integer getDuration()
Returns duration of this OdiSessionTaskLog, or null if undefined.

Returns:
duration of this OdiSessionTaskLog, or null if undefined

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

getErrorCount

public java.lang.Integer getErrorCount()
Returns the error count.

Returns:
the error count

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

getExecutionCount

public int getExecutionCount()
Returns the count of executions for this OdiSessionTaskLog.

Returns:
the count of executions for 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

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

getInternalOrder

public int getInternalOrder()
Returns the internal order value.

Returns:
internal order

getLogCounter

public OdiSessionTaskLog.LogCounter getLogCounter()
Returns LogCounter used by this OdiSessionTaskLog.

Returns:
LogCounter used by this OdiSessionTaskLog

getLogLevel

public LogLevel getLogLevel()
Returns level of log details for this OdiSessionTaskLog.

Returns:
level of log details for this OdiSessionTaskLog

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

getScenarioTaskNumber

public int getScenarioTaskNumber()
Returns the scenario task number.

Returns:
the scenario task number

getSecurityContainer

public IRepositoryEntity getSecurityContainer()
Description copied from interface: IRepositoryEntity
Define a generic way to retrieve container for entities.

Returns:
container entity

getSourceCommand

public java.lang.String getSourceCommand()
Returns the actual command executed on source, or null if undefined.

Returns:
the actual command executed on source, 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

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

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

getSourceIsolationLevel

public OdiSessionTaskLog.IsolationLevel getSourceIsolationLevel()
Returns source isolation level, or null if undefined.

Returns:
source isolation level, or null if undefined

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

getSourceTransactionId

public java.lang.String getSourceTransactionId()
Returns source transaction ID, or null if undefined.

Returns:
source transaction ID, 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

getStatus

public Status getStatus()
Returns status of this OdiSessionTaskLog.

Returns:
status of this OdiSessionTaskLog

getTargetCommand

public java.lang.String getTargetCommand()
Returns the actual command executed on target, or null if undefined.

Returns:
the actual command executed on target, 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

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

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

getTargetIsolationLevel

public OdiSessionTaskLog.IsolationLevel getTargetIsolationLevel()
Returns target isolation level, or null if undefined.

Returns:
target isolation level, or null if undefined

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

getTargetTransactionId

public java.lang.String getTargetTransactionId()
Returns target transaction ID, or null if undefined.

Returns:
target transaction ID, or null if undefined

getTaskLogNumber

public int getTaskLogNumber()
Returns the OdiSessionTaskLog's number.

Returns:
the OdiSessionTaskLog's number

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

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

isIgnoreError

public boolean isIgnoreError()
Returns whether errors are ignored for this OdiSessionTaskLog.

Returns:
whether errors are ignored for this OdiSessionTaskLog

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.3.0)

E17060-01

Copyright © 2010, Oracle and/or its affiliates. All rights reserved.