Skip navigation links

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

E17060-02


oracle.odi.domain.runtime.scenario
Class OdiScenarioReport

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

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

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

Defines execution report of an OdiScenario. It is part of the OdiScenario - OdiScenarioVariable - OdiScenarioSequence - OdiScenarioReport aggregate. However it also root of the OdiScenarioReport - OdiStepReport aggregate.

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

Since:
11.1.1.3.0
See Also:
Serialized Form

Method Summary
 java.lang.String getAgentName()
          Gets ODI agent name that has executed the scenario.
 java.lang.String getContextCode()
          Gets ODI context code on which the scenario has been executed.
 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 getScenarioExecutionNumber()
          Gets run number of the scenario, this report belongs to.
 IRepositoryEntity getSecurityContainer()
          Define a generic way to retrieve container for entities.
 java.lang.Integer getSessionDeleteCount()
          Gets delete count of relevant ODI session.
 java.lang.Integer getSessionDuration()
          Gets duration of relevant ODI session.
 java.util.Date getSessionEndTime()
          Gets end time of relevant ODI session.
 java.lang.Integer getSessionErrorCount()
          Gets error count of relevant ODI session.
 java.lang.String getSessionErrorMessage()
          Gets error message of relevant ODI session.
 java.lang.Integer getSessionInsertCount()
          Gets insert count of relevant ODI session.
 java.lang.String getSessionReturnCode()
          Gets return code of relevant ODI session.
 java.lang.Integer getSessionRowCount()
          Gets row count of relevant ODI session.
 java.util.Date getSessionStartTime()
          Gets start time of relevant ODI session.
 Status getSessionStatus()
          Gets status of relevant ODI session.
 java.lang.Integer getSessionUpdateCount()
          Gets update count of relevant ODI session.
 java.util.List<OdiStepReport> getStepReports()
          Gets ordered (by stepNumber and executionCount) list of step reports.

 

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

getAgentName

public java.lang.String getAgentName()
Gets ODI agent name that has executed the scenario.
Returns:
ODI agent name that has executed the scenario

getContextCode

public java.lang.String getContextCode()
Gets ODI context code on which the scenario has been executed.
Returns:
ODI context code on which the scenario has been executed

getSessionStartTime

public java.util.Date getSessionStartTime()
Gets start time of relevant ODI session.
Returns:
start time of relevant ODI session

getSessionEndTime

public java.util.Date getSessionEndTime()
Gets end time of relevant ODI session.
Returns:
end time of relevant ODI session

getSessionDuration

public java.lang.Integer getSessionDuration()
Gets duration of relevant ODI session.
Returns:
duration of relevant ODI session

getSessionReturnCode

public java.lang.String getSessionReturnCode()
Gets return code of relevant ODI session.
Returns:
return code of relevant ODI session

getSessionStatus

public Status getSessionStatus()
Gets status of relevant ODI session.
Returns:
status of relevant ODI session

getSessionErrorMessage

public java.lang.String getSessionErrorMessage()
Gets error message of relevant ODI session.
Returns:
error message of relevant ODI session

getSessionInsertCount

public java.lang.Integer getSessionInsertCount()
Gets insert count of relevant ODI session.
Returns:
insert count of relevant ODI session

getSessionDeleteCount

public java.lang.Integer getSessionDeleteCount()
Gets delete count of relevant ODI session.
Returns:
delete count of relevant ODI session

getSessionUpdateCount

public java.lang.Integer getSessionUpdateCount()
Gets update count of relevant ODI session.
Returns:
update count of relevant ODI session

getSessionErrorCount

public java.lang.Integer getSessionErrorCount()
Gets error count of relevant ODI session.
Returns:
error count of relevant ODI session

getSessionRowCount

public java.lang.Integer getSessionRowCount()
Gets row count of relevant ODI session.
Returns:
row count of relevant ODI session

getScenarioExecutionNumber

public int getScenarioExecutionNumber()
Gets run number of the scenario, this report belongs to.
Returns:
run number of the scenario, this report belongs to

getSecurityContainer

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

getStepReports

public java.util.List<OdiStepReport> getStepReports()
Gets ordered (by stepNumber and executionCount) list of step reports. Note that this list is an unmodifiable list.
Returns:
unmodifiable list of step reports. Ordered by Step Number and Execution Count

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

Skip navigation links

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

E17060-02


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