OdiSession (Oracle Fusion Middleware Java API Reference for Oracle Data Integrator)

java.lang.Object
- oracle.odi.domain.support.BusinessObject
- - oracle.odi.domain.support.AbstractRepositoryEntity
  - - oracle.odi.domain.support.AbstractOdiEntity
    - - oracle.odi.domain.runtime.session.OdiSession

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IOdiEntity, IRepositoryEntity, IWorkRuntimeOdiEntity, IRuntimeExecutable
```
public final class OdiSession
extends oracle.odi.domain.support.AbstractOdiEntity
implements IWorkRuntimeOdiEntity, IRuntimeExecutable
```
An OdiSession is an execution (of a scenario, an interface, a package or a procedure, ...) undertaken by an execution agent. OdiSession is the root entity in OdiSession - OdiSessionVariable - OdiSessionStepLog. It is identified by a unique session ID that can be obtained from getSessionId() method call.

Life cycle of an OdiSession begins when it is created / prepared from a scenario, an interface, etc. Once prepared, ODI Execution Engine can execute it. Life cycle ends when the session is removed from runtime repository.

Since:

11.1.1.3.0

See Also:

Serialized Form

Field Summary
- Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity
  STARTING_INTERNAL_VERSION

Constructor Summary

Constructors
Constructor and Description
`OdiSession(java.lang.String pSessionName, ExecutionMode pExeMode, Status pSessionStatus, java.lang.String pExeContext)` Deprecated. Replaced by `OdiSession(OdiSessionBlueprint, String, ExecutionMode, Status, String)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addSessionCustomStep(OdiSessionCustomStep pSessionCustomStep)` Adds the `OdiSessionCustomStep` to this `OdiSession`.
`void`	`addSessionCustomTask(OdiSessionCustomTask pSessionCustomTask)` Adds the `OdiSessionCustomTask` to this `OdiSession`.
`void`	`addSessionCustomVariable(OdiSessionCustomVariable pSessionCustomVariable)` Adds the `OdiSessionCustomVariable` to this `OdiSession`.
`void`	`addSessionParameter(OdiSessionParameter pSessionParameter)` Add the given `OdiSessionParameter` to the collection of `OdiSessionParameter`s.
`void`	`addSessionStepLog(OdiSessionStepLog pSessionStepLog)`
`java.lang.String`	`getAgentCreationTime()`
`java.lang.String`	`getAgentName()` Returns the name of the agent that manage this `OdiSession`.
`java.lang.String`	`getAgentThreadId()`
`int`	`getChildSessionCount()` Obtains the count of child `OdiSession`.
`java.lang.String`	`getContextCode()` Returns the execution context code for this `OdiSession`.
`java.lang.String`	`getDebugClientId()` INTERNAL: Returns id of the debug client connected to this session.
`java.lang.Integer`	`getDeleteCount()` Deprecated. consider using `getDeleteCountLong()` instead.
`java.lang.Long`	`getDeleteCountLong()` Relevant for Interfaces and Procedures and any execution that manipulates data.
`java.lang.Integer`	`getDuration()` Returns the duration of the `OdiSession` execution in second, or `null` if not yet defined (i.e.
`java.util.Date`	`getEndTime()` Returns the end time of the `OdiSession`, or `null` if the session isn't yet finished.
`java.lang.Integer`	`getErrorCount()` Deprecated. consider using `getErrorCountLong()` instead.
`java.lang.Long`	`getErrorCountLong()` Obtains number of errors of this session i.e.
`java.lang.String`	`getErrorMessage()` Obtains the error message of this `OdiSession` if failed, or `null` if the session successfully ended.
`java.lang.Long`	`getEssJobId()` Returns the ID of ESS Job which started this `OdiSession`.
`java.lang.String`	`getEssRequestExecutionContext()` Returns the RequestExecutionContext of ESS Job which started this `OdiSession`.
`ExecutionMode`	`getExecutionMode()` Returns execution mode for this OdiSession.
`java.lang.String`	`getExternalId()` Obtains the Oozie Id for this `OdiSession`.
`java.lang.String`	`getExternalName()` Obtains the Oozie application path for this `OdiSession`.
`java.lang.String`	`getExternalUrl()` Obtains the Url for the Oozie Console for this `OdiSession`.
`int`	`getFailedChildSessionCount()` Obtains the count of failed child `OdiSession`.
`OdiSessionStepLog`	`getFailureStepLog()` Return the step log (`OdiSessionStepLog`) that caused the session's failure.
`java.lang.Integer`	`getInsertCount()` Deprecated. consider using `getInsertCountLong()` instead.
`java.lang.Long`	`getInsertCountLong()` 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.
`java.lang.String`	`getKeywordsAsString()` Obtains comma separated list of keywords associated with `OdiSession`.
`LogLevel`	`getLogLevel()` Deprecated. As of 11.1.1.5 this method is replaced by #getExecutionMode()
`java.lang.String`	`getMasterAgentName()` Returns the name of agent received execution request for this session.
`java.lang.String`	`getName()` Returns the name of this `OdiSession` (i.e.
`java.lang.Integer`	`getNumberOfRuns()` Obtains the number of runs this `OdiSession` has been run/restarted.
`java.lang.Number`	`getParentSessionId()` Obtains the ID of parent `OdiSession`.
`java.lang.Integer`	`getRecordCount()` Deprecated. consider using `getRecordCountLong()` instead.
`java.lang.Long`	`getRecordCountLong()` Relevant for Interfaces and Procedures and any execution that manipulates data.
`java.lang.String`	`getReturnCode()` Obtains the return code of this `OdiSession`.
`OdiSessionStepLog`	`getRunningStepLog()` Obtains the current running step log (`OdiSessionStepLog`), or `null` if the execution is not yet started or is finished.
`OdiSessionBlueprint`	`getSessionBlueprint()` Returns related `OdiSessionBlueprint`, representing the execution plan of this session.
`java.util.Collection`	`getSessionCustomSteps()` Returns the unmodifiable collection of related `OdiSessionCustomStep`s
`java.util.Collection`	`getSessionCustomTasks()` Returns the unmodifiable collection of related `OdiSessionCustomTask`s
`java.util.Collection`	`getSessionCustomVariables()` Returns the unmodifiable collection of related `OdiSessionCustomVariable`s
`java.lang.Number`	`getSessionId()` Returns the ID of this `OdiSession`.
`OdiSessionParameter`	`getSessionParameter(java.lang.String pName)` Fetches the `OdiSessionParameter` with name `pName`.
`java.util.Collection`	`getSessionParameters()` Obtains the unmodifable collection of `OdiSessionParameter`s.
`java.util.Collection`	`getSessionSequences()` Deprecated. see `OdiSessionBlueprint` and `OdiSessionBlueprintSequence`
`java.util.List`	`getSessionStepLogs()` Obtains the ordered list of executed steps' logs (`OdiSessionStepLog`).
`java.util.Collection`	`getSessionVariables()` Deprecated. see `OdiSessionBlueprint` and `OdiSessionBlueprintVariable`
`Tag`	`getSourceScenarioTag()` Deprecated. replaced by `#getSessionBlueprint().getSourceScenarioTag()`
`java.util.Date`	`getStartTime()` Returns the start time of the `OdiSession`, or `null` if the session isn't started yet.
`java.lang.String`	`getStartupVariables()`
`Status`	`getStatus()` Obtains the current status of this `OdiSession`.
`java.util.List`	`getSteps()` Deprecated. consider using `OdiSessionBlueprintStep` instead.
`java.lang.String`	`getSubmitterName()` Obtains actual ODI user name that has submitted the `OdiSession`.
`int`	`getSuccessfulChildSessionCount()` Obtains the count of successful child `OdiSession`.
`java.lang.String`	`getSummaryMessage()` Obtains the summary of execution for this `OdiSession` for Oozie sessions and returns null for ODI native sessions.
`java.lang.Integer`	`getUpdateCount()` Deprecated. consider using `getUpdateCountLong()` instead.
`java.lang.Long`	`getUpdateCountLong()` Relevant for Interfaces and Procedures and any execution that manipulates data.
`boolean`	`isDebuggable()` Returns `true` if the session can be debugged, `false` otherwise.
`boolean`	`isEssJobSession()` Returns true if this `OdiSession` was started by ESS Job, false otherwise.
`boolean`	`isInstanceLevelSecurityNeeded()` Internal: this method is for internal purpose and must not be considered as part of the public API.
`boolean`	`isOozieSession()` Returns `true` if the session is Oozie Session, `false` otherwise.
`boolean`	`isOwbJobSession()` Returns `true` if the session is OWB Job, `false` otherwise.
`boolean`	`isSessionStartedSynchronously()`
`void`	`removeSessionParameter(OdiSessionParameter pSessionParameter)` Remove the given `OdiSessionParameter` from the collection of `OdiSessionParameter`s.
`void`	`removeStep(IRuntimeStep pStep)` Deprecated. consider using `OdiSessionBlueprintStep` instead.
`void`	`setAgentCreationTime(java.lang.String pCreationTime)`
`void`	`setAgentThreadId(java.lang.String pAgentThreadId)`
`void`	`setSessionStartedSynchronously(boolean pSessionStartedSynchronously)`
`void`	`setSourceScenarioTag(Tag pTag)` Deprecated. Source Scenario Tag property is owned by `OdiSessionBlueprint` from now, and thus it may be common for a number of Sessions. So its modification is not possible at this level.
`void`	`setStartupVariables(java.lang.String pStartupVariables)`
`void`	`setStatus(Status pStatus)` Set the current status of this session.

Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity
getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, isNew, preCommit, toString

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity
equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode

Methods inherited from class oracle.odi.domain.support.BusinessObject
clone

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.odi.domain.IOdiEntity
getFirstDate, getFirstUser, getLastDate, getLastUser

Methods inherited from interface oracle.odi.domain.IRepositoryEntity
getGlobalId, getParent

- Constructor Detail
  - OdiSession
```
public OdiSession(java.lang.String pSessionName,
                  ExecutionMode pExeMode,
                  Status pSessionStatus,
                  java.lang.String pExeContext)
```
    Deprecated. Replaced by OdiSession(OdiSessionBlueprint, String, ExecutionMode, Status, String)
- Method Detail
  - removeStep
```
public void removeStep(IRuntimeStep pStep)
```
    Deprecated. consider using OdiSessionBlueprintStep instead.
    
    Specified by:
    
    removeStep in interface IRuntimeExecutable
  - getSteps
```
public java.util.List getSteps()
```
    Deprecated. consider using OdiSessionBlueprintStep instead.
    
    Specified by:
    
    getSteps in interface IRuntimeExecutable
  - 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.
    
    Specified by:
    
    getInternalId in interface IRepositoryEntity
    
    Returns:
    
    the persistence identity of this instance
  - getName
```
public java.lang.String getName()
```
    Returns the name of this OdiSession (i.e. the name of the element that produce this session, this means the package, variable, scenario, etc.).
    
    Specified by:
    
    getName in interface IOdiEntity
    
    Overrides:
    
    getName in class oracle.odi.domain.support.AbstractOdiEntity
    
    Returns:
    
    the name of the OdiSession
  - getSessionId
```
public java.lang.Number getSessionId()
```
    Returns the ID of this OdiSession.
    
    Returns:
    
    the ID of this OdiSession
  - getStatus
```
public Status getStatus()
```
    Obtains the current status of this OdiSession.
    
    Returns:
    
    the current status of this OdiSession
    
    See Also:
    
    setStatus(Status)
  - getAgentName
```
public java.lang.String getAgentName()
```
    Returns the name of the agent that manage this OdiSession.
    
    Returns:
    
    the agent's name
  - getContextCode
```
public java.lang.String getContextCode()
```
    Returns the execution context code for this OdiSession.
    
    Returns:
    
    the execution context code
  - getSourceScenarioTag
```
public Tag getSourceScenarioTag()
```
    Deprecated. replaced by #getSessionBlueprint().getSourceScenarioTag()
    
    Obtains actual scenario's tag being executed or null if not executed from scenario.
    
    Returns:
    
    actual scenario's tag being executed
  - setSourceScenarioTag
```
public void setSourceScenarioTag(Tag pTag)
```
    Deprecated. Source Scenario Tag property is owned by OdiSessionBlueprint from now, and thus it may be common for a number of Sessions. So its modification is not possible at this level.
    
    Parameters:
    
    pTag - tag to set
  - getSubmitterName
```
public java.lang.String getSubmitterName()
```
    Obtains actual ODI user name that has submitted the OdiSession.
    
    Returns:
    
    actual ODI user name that has submitted the OdiSession
  - isInstanceLevelSecurityNeeded
```
public boolean isInstanceLevelSecurityNeeded()
```
    Description copied from interface: IOdiEntity
    
    Internal: this method is for internal purpose and must not be considered as part of the public API.
    Defines a method to capture the info on which object needs instance level privilege.
    
    Specified by:
    
    isInstanceLevelSecurityNeeded in interface IOdiEntity
    
    Overrides:
    
    isInstanceLevelSecurityNeeded in class oracle.odi.domain.support.AbstractOdiEntity
    
    Returns:
    
    true if instance level security needed, false otherwise
  - getKeywordsAsString
```
public java.lang.String getKeywordsAsString()
```
    Obtains comma separated list of keywords associated with OdiSession. Keywords are used to distribute this OdiSession into OdiSessionFolder.
    
    Returns:
    
    comma separated list of keywords associated with OdiSession
  - getStartTime
```
public java.util.Date getStartTime()
```
    Returns the start time of the OdiSession, or null if the session isn't started yet.
    
    Returns:
    
    the start time of the OdiSession
  - getEndTime
```
public java.util.Date getEndTime()
```
    Returns the end time of the OdiSession, or null if the session isn't yet finished.
    
    Returns:
    
    the end time of the OdiSession
  - getDuration
```
public java.lang.Integer getDuration()
```
    Returns the duration of the OdiSession execution in second, or null if not yet defined (i.e. the execution is still running).
    
    Returns:
    
    the duration of the OdiSession execution in second
  - getReturnCode
```
public java.lang.String getReturnCode()
```
    Obtains the return code of this OdiSession.
    The return code is obtained from the execution channel of the last task, e.g. operating system code, database error code, etc. It will be "0" (zero) in case of success.
    
    Returns:
    
    the return code of this OdiSession
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    Obtains the error message of this OdiSession if failed, or null if the session successfully ended.
    
    Returns:
    
    the error message of this OdiSession if failed
  - getChildSessionCount
```
public int getChildSessionCount()
```
    Obtains the count of child OdiSession.
    
    Returns:
    
    the count of child OdiSession
  - getSuccessfulChildSessionCount
```
public int getSuccessfulChildSessionCount()
```
    Obtains the count of successful child OdiSession.
    
    Returns:
    
    the count of successful child OdiSession
  - getFailedChildSessionCount
```
public int getFailedChildSessionCount()
```
    Obtains the count of failed child OdiSession.
    
    Returns:
    
    the count of failed child OdiSession
  - getSessionStepLogs
```
public java.util.List getSessionStepLogs()
```
    Obtains the ordered list of executed steps' logs (OdiSessionStepLog). If a running step exists it will be the last one in the returned list.
    
    Returns:
    
    an unmodifiable list of step's logs (OdiSessionStepLog)
  - getFailureStepLog
```
public OdiSessionStepLog getFailureStepLog()
```
    Return the step log (OdiSessionStepLog) that caused the session's failure. If the session didn't failed, than method will always return null. However, it can be null even if session is failed (e.g. session failed at preparation time).
    
    Returns:
    
    the step log (OdiSessionStepLog) that caused the session's failure, or null if the session didn't failed
  - getRunningStepLog
```
public OdiSessionStepLog getRunningStepLog()
```
    Obtains the current running step log (OdiSessionStepLog), or null if the execution is not yet started or is finished.
    
    Returns:
    
    the current running step log (OdiSessionStepLog)
  - getParentSessionId
```
public java.lang.Number getParentSessionId()
```
    Obtains the ID of parent OdiSession.
    
    Returns:
    
    the ID of parent OdiSession
  - getRecordCount
```
public java.lang.Integer getRecordCount()
```
    Deprecated. consider using getRecordCountLong() instead.
    
    Relevant for Interfaces and Procedures and any execution that manipulates data.
    
    Obtains overall numbers of records processed by this session i.e. the sum of records processed by each steps of this OdiSession.
    
    Returns:
    
    number of records processed by this session, or null if not applicable
    
    See Also:
    
    OdiSessionStepLog.getRecordCount()
  - getRecordCountLong
```
public java.lang.Long getRecordCountLong()
```
    Relevant for Interfaces and Procedures and any execution that manipulates data.
    
    Obtains overall numbers of records processed by this session i.e. the sum of records processed by each steps of this OdiSession.
    
    Returns:
    
    number of records processed by this session, or null if not applicable
    
    See Also:
    
    OdiSessionStepLog.getRecordCountLong()
  - getInsertCount
```
public java.lang.Integer getInsertCount()
```
    Deprecated. consider using getInsertCountLong() instead.
    
    Relevant for Interfaces and Procedures and any execution that manipulates data.
    
    Obtains overall numbers of rows inserted during execution of this session i.e. the sum of insert made by each steps of this OdiSession.
    
    Returns:
    
    the number of rows inserted during the execution of this session
    
    See Also:
    
    OdiSessionStepLog.getInsertCount()
  - getInsertCountLong
```
public java.lang.Long getInsertCountLong()
```
    Relevant for Interfaces and Procedures and any execution that manipulates data.
    
    Obtains overall numbers of rows inserted during execution of this session i.e. the sum of insert made by each steps of this OdiSession.
    
    Returns:
    
    the number of rows inserted during the execution of this session
    
    See Also:
    
    OdiSessionStepLog.getInsertCountLong()
  - getUpdateCount
```
public java.lang.Integer getUpdateCount()
```
    Deprecated. consider using getUpdateCountLong() instead.
    
    Relevant for Interfaces and Procedures and any execution that manipulates data.
    
    Obtains overall numbers of rows updated during execution of this session i.e. the sum of update made by each steps of this OdiSession.
    
    Returns:
    
    the number of rows updated during the execution of this session
    
    See Also:
    
    OdiSessionStepLog.getUpdateCount()
  - getUpdateCountLong
```
public java.lang.Long getUpdateCountLong()
```
    Relevant for Interfaces and Procedures and any execution that manipulates data.
    
    Obtains overall numbers of rows updated during execution of this session i.e. the sum of update made by each steps of this OdiSession.
    
    Returns:
    
    the number of rows updated during the execution of this session
    
    See Also:
    
    OdiSessionStepLog.getUpdateCountLong()
  - getDeleteCount
```
public java.lang.Integer getDeleteCount()
```
    Deprecated. consider using getDeleteCountLong() instead.
    
    Relevant for Interfaces and Procedures and any execution that manipulates data.
    
    Obtains overall numbers of rows deleted during execution of this session i.e. the sum of delete made by each steps of this OdiSession.
    
    Returns:
    
    the number of rows deleted during the execution of this session
    
    See Also:
    
    OdiSessionStepLog.getDeleteCount()
  - getDeleteCountLong
```
public java.lang.Long getDeleteCountLong()
```
    Relevant for Interfaces and Procedures and any execution that manipulates data.
    
    Obtains overall numbers of rows deleted during execution of this session i.e. the sum of delete made by each steps of this OdiSession.
    
    Returns:
    
    the number of rows deleted during the execution of this session
    
    See Also:
    
    OdiSessionStepLog.getDeleteCountLong()
  - getErrorCount
```
public java.lang.Integer getErrorCount()
```
    Deprecated. consider using getErrorCountLong() instead.
    
    Obtains number of errors of this session i.e. the sum of errors of each steps of this OdiSession.
    
    Returns:
    
    the number of errors
    
    See Also:
    
    OdiSessionStepLog.getErrorCount()
  - getErrorCountLong
```
public java.lang.Long getErrorCountLong()
```
    Obtains number of errors of this session i.e. the sum of errors of each steps of this OdiSession.
    
    Returns:
    
    the number of errors
    
    See Also:
    
    OdiSessionStepLog.getErrorCount()
  - getNumberOfRuns
```
public java.lang.Integer getNumberOfRuns()
```
    Obtains the number of runs this OdiSession has been run/restarted.
    
    Returns:
    
    the number of runs
  - getExternalId
```
public java.lang.String getExternalId()
```
    Obtains the Oozie Id for this OdiSession.
    
    Returns:
    
    externalId
  - getExternalName
```
public java.lang.String getExternalName()
```
    Obtains the Oozie application path for this OdiSession.
    
    Returns:
    
    the externalName
  - getExternalUrl
```
public java.lang.String getExternalUrl()
```
    Obtains the Url for the Oozie Console for this OdiSession.
    
    Returns:
    
    the externalUrl
  - getSummaryMessage
```
public java.lang.String getSummaryMessage()
```
    Obtains the summary of execution for this OdiSession for Oozie sessions and returns null for ODI native sessions.
    
    Returns:
    
    the summaryMessage
  - getSessionVariables
```
public java.util.Collection getSessionVariables()
```
    Deprecated. see OdiSessionBlueprint and OdiSessionBlueprintVariable
    
    Obtains an unmodifiable collection of the variables that are defined for this OdiSession.
    
    Returns:
    
    a collection of OdiSessionVariable
  - getSessionSequences
```
public java.util.Collection getSessionSequences()
```
    Deprecated. see OdiSessionBlueprint and OdiSessionBlueprintSequence
    
    Obtains an unmodifiable collection of the sequences that are defined for this OdiSession.
    
    Returns:
    
    a collection of OdiSessionSequence
  - isEssJobSession
```
public boolean isEssJobSession()
```
    Returns true if this OdiSession was started by ESS Job, false otherwise.
    
    Returns:
    
    true if this OdiSession was started by ESS Job, false otherwise
  - getEssJobId
```
public java.lang.Long getEssJobId()
```
    Returns the ID of ESS Job which started this OdiSession.
    
    Returns:
    
    the ID of ESS Job which started this OdiSession
    
    Throws:
    
    java.lang.IllegalStateException - if this OdiSession is not ESS Job related
  - getEssRequestExecutionContext
```
public java.lang.String getEssRequestExecutionContext()
```
    Returns the RequestExecutionContext of ESS Job which started this OdiSession.
    
    Returns:
    
    the RequestExecutionContext of ESS Job which started this OdiSession
    
    Throws:
    
    java.lang.IllegalStateException - if this OdiSession is not ESS Job related
    
    Since:
    
    11.1.1.5.0
  - getSessionParameters
```
public java.util.Collection getSessionParameters()
```
    Obtains the unmodifable collection of OdiSessionParameters.
    
    Returns:
    
    a Collection object representing the Session Parameter value
    
    See Also:
    
    addSessionParameter(OdiSessionParameter), removeSessionParameter(OdiSessionParameter)
  - getLogLevel
```
@Deprecated
public LogLevel getLogLevel()
```
    Deprecated. As of 11.1.1.5 this method is replaced by #getExecutionMode()
    
    Returns logging level of this session.
    
    Returns:
    
    logging level
  - getExecutionMode
```
public ExecutionMode getExecutionMode()
```
    Returns execution mode for this OdiSession.
    
    Returns:
    
    an ExecutionMode
    
    See Also:
    
    ExecutionMode
  - getMasterAgentName
```
public java.lang.String getMasterAgentName()
```
    Returns the name of agent received execution request for this session. May be different from agentName if the agent involved in load balancing.
    
    Returns:
    
    master agent's name
  - getAgentThreadId
```
public java.lang.String getAgentThreadId()
```
  - setAgentThreadId
```
public void setAgentThreadId(java.lang.String pAgentThreadId)
```
  - getAgentCreationTime
```
public java.lang.String getAgentCreationTime()
```
  - setAgentCreationTime
```
public void setAgentCreationTime(java.lang.String pCreationTime)
```
  - isSessionStartedSynchronously
```
public boolean isSessionStartedSynchronously()
```
  - setSessionStartedSynchronously
```
public void setSessionStartedSynchronously(boolean pSessionStartedSynchronously)
```
  - getStartupVariables
```
public java.lang.String getStartupVariables()
```
  - setStartupVariables
```
public void setStartupVariables(java.lang.String pStartupVariables)
```
  - setStatus
```
public void setStatus(Status pStatus)
```
    Set the current status of this session.
    
    Parameters:
    
    pStatus - the status
    
    Since:
    
    11.1.1.5.0
    
    See Also:
    
    getStatus()
  - isOwbJobSession
```
public boolean isOwbJobSession()
```
    Returns true if the session is OWB Job, false otherwise.
    
    Returns:
    
    whether the session is OWB Job
  - isOozieSession
```
public boolean isOozieSession()
```
    Returns true if the session is Oozie Session, false otherwise.
    
    Returns:
    
    whether the session is Oozie Session
  - isDebuggable
```
public boolean isDebuggable()
```
    Returns true if the session can be debugged, false otherwise.
    
    Returns:
    
    if the session is debuggable
  - getDebugClientId
```
public java.lang.String getDebugClientId()
```
    INTERNAL: Returns id of the debug client connected to this session.
  - getSessionBlueprint
```
public OdiSessionBlueprint getSessionBlueprint()
```
    Returns related OdiSessionBlueprint, representing the execution plan of this session.
    
    Returns:
    
    OdiSessionBlueprint
  - getSessionCustomSteps
```
public java.util.Collection getSessionCustomSteps()
```
    Returns the unmodifiable collection of related OdiSessionCustomSteps
    
    Returns:
    
    OdiSessionCustomSteps
  - getSessionCustomTasks
```
public java.util.Collection getSessionCustomTasks()
```
    Returns the unmodifiable collection of related OdiSessionCustomTasks
    
    Returns:
    
    OdiSessionCustomTasks
  - getSessionCustomVariables
```
public java.util.Collection getSessionCustomVariables()
```
    Returns the unmodifiable collection of related OdiSessionCustomVariables
    
    Returns:
    
    OdiSessionCustomVariables
  - addSessionCustomStep
```
public void addSessionCustomStep(OdiSessionCustomStep pSessionCustomStep)
```
    Adds the OdiSessionCustomStep to this OdiSession.
    
    Parameters:
    
    pSessionCustomStep - OdiSessionCustomStep to add
  - addSessionCustomVariable
```
public void addSessionCustomVariable(OdiSessionCustomVariable pSessionCustomVariable)
```
    Adds the OdiSessionCustomVariable to this OdiSession.
    
    Parameters:
    
    pSessionCustomVariable - OdiSessionCustomVariable to add
  - addSessionCustomTask
```
public void addSessionCustomTask(OdiSessionCustomTask pSessionCustomTask)
```
    Adds the OdiSessionCustomTask to this OdiSession.
    
    Parameters:
    
    pSessionCustomTask - OdiSessionCustomTask to add
  - addSessionStepLog
```
public void addSessionStepLog(OdiSessionStepLog pSessionStepLog)
```
  - addSessionParameter
```
public void addSessionParameter(OdiSessionParameter pSessionParameter)
```
    Add the given OdiSessionParameter to the collection of OdiSessionParameters. This will also set the Session of the given OdiSessionParameter to this OdiSession instance.
    
    Parameters:
    
    pSessionParameter - an OdiSessionParameter object
    
    Throws:
    
    DomainRuntimeException - if pSessionParameter is null or if a Session Parameter with the same name already exists in this OdiSession
  - removeSessionParameter
```
public void removeSessionParameter(OdiSessionParameter pSessionParameter)
```
    Remove the given OdiSessionParameter from the collection of OdiSessionParameters.
    
    Parameters:
    
    OdiSessionParameter - OdiSessionParameter object to be removed
    
    Throws:
    
    DomainRuntimeException - if pSessionParameter is null or belongs to a different OdiSession
  - getSessionParameter
```
public OdiSessionParameter getSessionParameter(java.lang.String pName)
```
    Fetches the OdiSessionParameter with name pName. Returns null if no OdiSessionParameter with name pName exists in this Session
    
    Parameters:
    
    pName - Name of the Session Parameter to fetch
    
    Returns:
    
    OdiSessionParameter with name pName.
    
    Throws:
    
    DomainRuntimeException - if pName is null

Class OdiSession

Field Summary

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity

Constructor Summary

Method Summary

Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

Methods inherited from class oracle.odi.domain.support.BusinessObject

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.odi.domain.IOdiEntity

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

Constructor Detail

OdiSession

Method Detail

removeStep

getSteps

getInternalId

getName

getSessionId

getStatus

getAgentName

getContextCode

getSourceScenarioTag

setSourceScenarioTag

getSubmitterName

isInstanceLevelSecurityNeeded

getKeywordsAsString

getStartTime

getEndTime

getDuration

getReturnCode

getErrorMessage

getChildSessionCount

getSuccessfulChildSessionCount

getFailedChildSessionCount

getSessionStepLogs

getFailureStepLog

getRunningStepLog

getParentSessionId

getRecordCount

getRecordCountLong

getInsertCount

getInsertCountLong

getUpdateCount

getUpdateCountLong

getDeleteCount

getDeleteCountLong

getErrorCount

getErrorCountLong

getNumberOfRuns

getExternalId

getExternalName

getExternalUrl

getSummaryMessage

getSessionVariables

getSessionSequences

isEssJobSession

getEssJobId

getEssRequestExecutionContext

getSessionParameters

getLogLevel

getExecutionMode

getMasterAgentName

getAgentThreadId

setAgentThreadId

getAgentCreationTime

setAgentCreationTime

isSessionStartedSynchronously

setSessionStartedSynchronously

getStartupVariables

setStartupVariables

setStatus

isOwbJobSession

isOozieSession

isDebuggable

getDebugClientId

getSessionBlueprint

getSessionCustomSteps

getSessionCustomTasks

getSessionCustomVariables