Skip navigation links

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

E17060-04


oracle.odi.domain.runtime.scenario
Class OdiStepReport

java.lang.Object
  extended by oracle.odi.domain.support.BusinessObject
      extended by oracle.odi.domain.support.AbstractRepositoryEntity
          extended by oracle.odi.domain.runtime.scenario.OdiStepReport

All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, IRepositoryEntity

public final class OdiStepReport
extends oracle.odi.domain.support.AbstractRepositoryEntity

Defines execution report of an OdiScenario's step. It is part of the OdiScenarioReport - OdiStepReport aggregate.

An OdiStepReport life cycle begins when an OdiScenarioReport is created. Once created an OdiStepReport cannot be updated. It would be possible to remove an OdiStepReport from its enclosing OdiScenarioReport (thus delete it from runtime repository), but this will not be supported by the API for now. Its life cycle ends when enclosing OdiScenarioReport is removed from runtime repository.

Since:
11.1.1.3.0
See Also:
Serialized Form

Method Summary
 int getExecutionOrder()
          Reruns the execution order of this step report.
 java.io.Serializable getInternalId()
          Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
 IRepositoryEntity getSecurityContainer()
          Define a generic way to retrieve container for entities.
 java.lang.String getStepContextCode()
          Returns the context code on which the step was executed.
 java.lang.Integer getStepDeleteCount()
          Obtains the number of delete operations.
 java.lang.Integer getStepDuration()
          Obtains the duration of step execution in seconds.
 java.util.Date getStepEndTime()
          Obtains the timestamp represented the end of step execution.
 java.lang.Integer getStepErrorCount()
          Obtains the number of detected errors.
 java.lang.String getStepErrorMessage()
          Obtains the message of first detected error (if any).
 int getStepExecutionCount()
          Obtains execution count of this OdiStepReport.
 java.lang.String getStepForcedContextCode()
          Returns the forced context code, if the context was forced to a different context than the execution context.
 java.lang.Integer getStepInsertCount()
          Obtains the number of insert operations.
 java.lang.String getStepLogicalSchemaName()
          Returns the logical schema name on which this step was executed.
 java.lang.String getStepModelCode()
          Returns the code of the model to which the target table of this step belongs, if any; null if none.
 java.lang.String getStepName()
          Obtains the name of this OdiStepReport.
 int getStepNumber()
          Obtains the sequence number of this OdiStepReport.
 java.lang.String getStepResourceName()
          Returns the resource name (i.e.
 java.lang.String getStepReturnCode()
          Obtains the return code of this OdiStepReport.
 java.lang.Integer getStepRowCount()
          Obtains the number of affected rows.
 java.util.Date getStepStartTime()
          Obtains the timestamp represented the start of step execution.
 Status getStepStatus()
          Obtains the status (Status) of this OdiStepReport.
 java.lang.String getStepTableName()
          Returns the name of the table affected by this step, if any; null if none.
 java.lang.Integer getStepUpdateCount()
          Obtains the number of update operations.

 

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

getStepStatus

public Status getStepStatus()
Obtains the status (Status) of this OdiStepReport.
Returns:
the status (Status) of this OdiStepReport

getStepName

public java.lang.String getStepName()
Obtains the name of this OdiStepReport.
Returns:
the name of this OdiStepReport

getStepNumber

public int getStepNumber()
Obtains the sequence number of this OdiStepReport.
Returns:
the sequence number of this OdiStepReport

getStepStartTime

public java.util.Date getStepStartTime()
Obtains the timestamp represented the start of step execution.
Returns:
the timestamp represented the start of step execution

getStepEndTime

public java.util.Date getStepEndTime()
Obtains the timestamp represented the end of step execution.
Returns:
the timestamp represented the end of step execution

getStepDuration

public java.lang.Integer getStepDuration()
Obtains the duration of step execution in seconds.
Returns:
the duration of step execution in seconds

getStepErrorMessage

public java.lang.String getStepErrorMessage()
Obtains the message of first detected error (if any).
Returns:
the message of first detected error (if any)

getStepReturnCode

public java.lang.String getStepReturnCode()
Obtains the return code of this OdiStepReport.
Returns:
the return code of this OdiStepReport

getStepExecutionCount

public int getStepExecutionCount()
Obtains execution count of this OdiStepReport.
Returns:
execution count of this OdiStepReport

getStepInsertCount

public java.lang.Integer getStepInsertCount()
Obtains the number of insert operations.
Returns:
the number of insert operations

getStepUpdateCount

public java.lang.Integer getStepUpdateCount()
Obtains the number of update operations.
Returns:
the number of update operations

getStepDeleteCount

public java.lang.Integer getStepDeleteCount()
Obtains the number of delete operations.
Returns:
the number of delete operations

getStepErrorCount

public java.lang.Integer getStepErrorCount()
Obtains the number of detected errors.
Returns:
the number of detected errors

getStepRowCount

public java.lang.Integer getStepRowCount()
Obtains the number of affected rows.
Returns:
the number of affected rows

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

getStepContextCode

public java.lang.String getStepContextCode()
Returns the context code on which the step was executed.
Returns:
the context code

getStepLogicalSchemaName

public java.lang.String getStepLogicalSchemaName()
Returns the logical schema name on which this step was executed.
Returns:
the logical schema name

getStepModelCode

public java.lang.String getStepModelCode()
Returns the code of the model to which the target table of this step belongs, if any; null if none.
Returns:
the model code

getStepTableName

public java.lang.String getStepTableName()
Returns the name of the table affected by this step, if any; null if none.
Returns:
the table name

getStepResourceName

public java.lang.String getStepResourceName()
Returns the resource name (i.e. physical name of the table or underlying resource) affected by this step, if any; null if none.
Returns:
the resource name

getStepForcedContextCode

public java.lang.String getStepForcedContextCode()
Returns the forced context code, if the context was forced to a different context than the execution context. Null otherwise.
Returns:
the forced context code

getExecutionOrder

public int getExecutionOrder()
Reruns the execution order of this step report.
Returns:
the Execution Order
Since:
11.1.1.5.0

Skip navigation links

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

E17060-04


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