|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.5.0) E17060-02 |
|||||||||
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.OdiSessionStepLog
public final class OdiSessionStepLog
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.
Nested Class Summary | |
---|---|
static class |
OdiSessionStepLog.OdiSessionStepLogId |
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. |
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. |
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. |
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. |
java.lang.Number |
getSessionId() Returns the ID of OdiSession this OdiSessionStepLog is related to. |
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.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 true if context was forced to a different context than the execution context, false otherwise. |
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. |
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 |
---|
public java.util.List<OdiSessionTaskLog> getSessionTaskLogs()
OdiSessionTaskLog
) that belong to this OdiSessionStepLog
.public java.lang.String getContextCode()
OdiSessionStepLog
. Maybe the execution context, or a forced context for this step.public java.lang.Integer getDeleteCount()
null
if not applicable.
Relevant for Interfaces and Procedures and any execution that manipulates data.
public java.lang.Integer getDuration()
null
if not yet defined.public java.util.Date getEndTime()
null
if not yet finished.public java.lang.Integer getErrorCount()
public java.lang.String getErrorMessage()
null
if not failed.public int getExecutionCount()
OdiSessionStepLog
within the session.public boolean isContextForced()
public java.lang.Integer getInsertCount()
null
if not applicable.
Relevant for Interfaces and Procedures and any execution that manipulates data.
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 java.lang.String getName()
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.public java.lang.Integer getRecordCount()
null
if not applicable.
Relevant for Interfaces and Procedures and any execution that manipulates data.
public java.lang.String getReturnCode()
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
public java.util.Date getStartTime()
null
if not yet started.public Status getStatus()
setStatus(Status)
public void setStatus(Status pStatus)
pStatus
- the statusgetStatus()
public int getStepNumber()
OdiSessionStepLog
within the initial package.OdiSessionStepLog
within the initial packagepublic StepType getStepType()
OdiSessionStepLog
.public java.lang.String getTargetLogicalSchemaName()
public java.lang.String getTargetModelCode()
public java.lang.String getTargetResourceName()
public java.lang.String getTargetTableName()
public java.lang.Integer getUpdateCount()
null
if not applicable.
Relevant for Interfaces and Procedures and any execution that manipulates data.
public boolean isMaxErrorCountAsPercentage()
true
if percentage, false
otherwise.getMaxErrorCount()
, setMaxErrorCountAsPercentage(boolean)
public void setMaxErrorCountAsPercentage(boolean pMaxErrorCountAsPercentage)
pMaxErrorCountAsPercentage
- true
to indicate a percentage, false
otherwiseisMaxErrorCountAsPercentage()
, setMaxErrorCount(java.lang.Integer)
public java.lang.Integer getMaxErrorCount()
setMaxErrorCount(Integer)
, isMaxErrorCountAsPercentage()
public void setMaxErrorCount(java.lang.Integer pMaxErrorCount)
pMaxErrorCount
- the maximum of errorsgetMaxErrorCount()
, setMaxErrorCountAsPercentage(boolean)
public java.lang.Number getSessionId()
OdiSession
this OdiSessionStepLog
is related to.public OdiSessionStepLog getNextStepAfterFailure()
OdiSessionStepLog
, if it failed.
If no next OdiSessionStepLog
was defined (null is defined), the execution will stop after failure.
null
is nonepublic OdiSessionStepLog getNextStepAfterSuccess()
OdiSessionStepLog
, if it succeeds.
If no next OdiSessionStepLog
was defined (null is defined), the execution will stop after success.
public java.lang.String getKoExitCode()
public java.lang.String getOkExitCode()
public boolean isOkExit()
true
if exit required on success, false
- otherwise.true
if exit required on success, false
- otherwisepublic boolean isKoExit()
true
if exit required on failure, false
- otherwise.true
if exit required on failure, false
- otherwisepublic int getFailureRetryNumber()
public int getFailureRetryDelay()
public java.lang.String getVariableName()
public java.lang.String getVariableValue()
These values are evaluated before the execution of the step
.public java.lang.Number getVariableIncrement()
public VariableOperator getVariableOperator()
link VariableOperator}
public int getExecutionOrder()
OdiSession
.
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.5.0) E17060-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |