|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.7.0) E17060-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.runtime.session.OdiSessionTaskLog
public final class OdiSessionTaskLog
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.
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 |
---|
public java.io.Serializable getInternalId()
IRepositoryEntity
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.
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
public int getInternalOrder()
public TaskType getType()
public java.lang.String getTaskName1()
OdiSessionTaskLog
, or null if undefined.OdiSessionTaskLog
, or null if undefinedpublic java.lang.String getTaskName2()
OdiSessionTaskLog
, or null if undefined.OdiSessionTaskLog
, or null if undefinedpublic java.lang.String getTaskName3()
OdiSessionTaskLog
, or null if undefined.OdiSessionTaskLog
, or null if undefinedpublic java.util.Date getStartTime()
OdiSessionTaskLog
, or null if not yet started.OdiSessionTaskLog
, or null if not yet startedpublic java.util.Date getEndTime()
OdiSessionTaskLog
, or null if not yet finished.OdiSessionTaskLog
, or null if not yet finishedpublic java.lang.Integer getDuration()
OdiSessionTaskLog
, or null if undefined.OdiSessionTaskLog
, or null if undefinedpublic Status getStatus()
OdiSessionTaskLog
.OdiSessionTaskLog
setStatus(Status)
public void setStatus(Status pStatus)
pStatus
- the statusgetStatus()
public java.lang.String getReturnCode()
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.OdiSessionTaskLog
public java.lang.String getErrorMessage()
OdiSessionTaskLog
. Will always be null if not failed.OdiSessionTaskLog
. Will always be null if not failedpublic OdiSessionTaskLog.LogCounter getLogCounter()
OdiSessionTaskLog
.OdiSessionTaskLog
public java.lang.Integer getInsertCount()
public java.lang.Integer getUpdateCount()
public java.lang.Integer getDeleteCount()
public java.lang.Integer getRecordCount()
null
if not applicablepublic java.lang.Integer getErrorCount()
public java.lang.String getSourceContextCode()
public java.lang.String getSourceLogicalSchemaName()
public java.lang.String getSourceDataServerName()
public java.lang.String getSourceTransactionId()
public OdiSessionTaskLog.IsolationLevel getSourceIsolationLevel()
public OdiSessionTaskLog.CommitMode getSourceCommitMode()
public java.lang.String getSourceCommand()
null
if undefinedsetSourceCommand(String)
public void setSourceCommand(java.lang.String pSourceCmd)
pSourceCmd
- the source commandgetSourceCommand()
public java.lang.String getTargetContextCode()
public java.lang.String getTargetLogicalSchemaName()
public java.lang.String getTargetDataServerName()
public java.lang.String getTargetTransactionId()
public OdiSessionTaskLog.IsolationLevel getTargetIsolationLevel()
public OdiSessionTaskLog.CommitMode getTargetCommitMode()
public java.lang.String getTargetCommand()
null
if undefinedsetTargetCommand(String)
public void setTargetCommand(java.lang.String pTargetCmd)
pTargetCmd
- the target commandgetTargetCommand()
public int getScenarioTaskNumber()
public int getExecutionCount()
OdiSessionStepLog
since executionCount of a setp log and task log are the sameOdiSessionTaskLog
.OdiSessionTaskLog
public int getTaskLogNumber()
OdiSessionStepLog
since stepNumber of a step log and taskLogNumber are the sameOdiSessionTaskLog
's number.OdiSessionTaskLog
's numberpublic LogLevel getLogLevel()
OdiSessionTaskLog
.OdiSessionTaskLog
public boolean isIgnoreError()
OdiSessionTaskLog
.true
if errors are ignored, false
otherwisesetIgnoreError(boolean)
public void setIgnoreError(boolean pIgnoreError)
OdiSessionTaskLog
.pIgnoreError
- true
to ignore errors, false
otherwiseisIgnoreError()
public boolean getLogFinalCommand()
OdiSessionTaskLog
.true
if final command text should be logged, false
otherwise.OdiProcedureLine.getLogFinalCommand()
, OdiProcedureLine.setLogFinalCommand(boolean)
public OdiSessionStepLog getSessionStepLog()
public java.lang.String getResolvedSourceCommand()
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.
getSourceCommand()
, OdiSessionStepLog.getTrackedVariableValues()
public java.lang.String getResolvedTargetCommand()
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.
getTargetCommand()
, OdiSessionStepLog.getTrackedVariableValues()
public java.util.Collection<OdiTrackedSequenceValue> getTrackedSequenceValues()
OdiSessionStepLog.isTrackingEnabled()
, OdiSessionStepLog#getTrackedSequenceValues()
public OdiSessionTaskLog.ValueTrackingMode getValueTrackingMode()
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.7.0) E17060-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |