AbstractRuntimeStep (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.runtime.common.AbstractRuntimeStep

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity

Direct Known Subclasses:

OdiScenarioStep, OdiSessionBlueprintStep, OdiSessionCustomStep
```
public abstract class AbstractRuntimeStep
extends oracle.odi.domain.support.AbstractRepositoryEntity
```
This is the common abstract class for ODI runtime step - scenario or session step. Its concrete subclasses are OdiScenarioStep, OdiSessionBlueprintStep and OdiSessionCustomStep.

Since:

12.1.2

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AbstractRuntimeStep()

Constructors
Constructor and Description
`AbstractRuntimeStep()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getContextCode()` Returns the context code for this `AbstractRuntimeStep`.
`int`	`getFailureRetryDelay()` Returns the delay in milliseconds between retries on failure for this `AbstractRuntimeStep`.
`int`	`getFailureRetryNumber()` Returns the retry number on failure for this `AbstractRuntimeStep`.
`GenerationInfo`	`getGenerationInfo()` Returns the generation info for this step, which is the KM option information.
`java.lang.String`	`getKoExitCode()` Returns the exit code on failure for this `AbstractRuntimeStep`.
`StepLoggingMethod`	`getLogMethod()` Returns the logging method for this `AbstractRuntimeStep`.
`java.lang.Integer`	`getMaxErrorCount()` Returns the max error allowed for this `AbstractRuntimeStep`.
`java.lang.String`	`getName()` Returns the name of this `AbstractRuntimeStep`.
`java.lang.String`	`getOkExitCode()` Returns the exit code on success for this `AbstractRuntimeStep`.
`int`	`getStepNumber()` Returns the step number of this `AbstractRuntimeStep`.
`java.lang.String`	`getTargetLogicalSchemaName()` Returns the target logical schema name for this `AbstractRuntimeStep`.
`java.lang.String`	`getTargetModelCode()` Returns the target model code for this `AbstractRuntimeStep`.
`java.lang.String`	`getTargetResourceName()` Returns the target resource name for this `AbstractRuntimeStep`.
`java.lang.String`	`getTargetTableName()` Returns the target table name for this `AbstractRuntimeStep`.
`StepType`	`getType()` Returns the type of this `AbstractRuntimeStep`.
`java.lang.Number`	`getVariableIncrement()` Returns the variable increment for this `AbstractRuntimeStep`.
`java.lang.String`	`getVariableName()` Returns the variable name for this `AbstractRuntimeStep`.
`VariableOperator`	`getVariableOperator()` Returns the variable operator for this `AbstractRuntimeStep`.
`java.lang.String`	`getVariableValue()` Returns the variable value for this `AbstractRuntimeStep`.
`boolean`	`isCleanupOnError()` Returns true if cleanup tasks should be performed on error, false otherwise.
`boolean`	`isContextForced()` Returns true if context is forced for this `AbstractRuntimeStep`, false - otherwise.
`boolean`	`isKoExit()` Returns `true` if exit required on failure, `false` - otherwise.
`boolean`	`isMaxErrorCountAsPercentage()` Indicates whether max error count value is of percentage representation.
`boolean`	`isOkExit()` Returns `true` if exit required on success, `false` - otherwise.
`void`	`setGenerationInfo(GenerationInfo generationInfo)` Sets the generation info for this step, which is the KM option information.

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

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.IRepositoryEntity
getInternalId

- Constructor Detail
  - AbstractRuntimeStep
```
public AbstractRuntimeStep()
```
- Method Detail
  - getStepNumber
```
public int getStepNumber()
```
    Returns the step number of this AbstractRuntimeStep.
    
    Returns:
    
    the step number
  - getName
```
public java.lang.String getName()
```
    Returns the name of this AbstractRuntimeStep.
    
    Returns:
    
    the step name
  - getType
```
public StepType getType()
```
    Returns the type of this AbstractRuntimeStep.
    
    Returns:
    
    the step type
  - isContextForced
```
public boolean isContextForced()
```
    Returns true if context is forced for this AbstractRuntimeStep, false - otherwise.
    
    Returns:
    
    whether context is forced
  - getContextCode
```
public java.lang.String getContextCode()
```
    Returns the context code for this AbstractRuntimeStep.
    
    Returns:
    
    the context code
  - getVariableName
```
public java.lang.String getVariableName()
```
    Returns the variable name for this AbstractRuntimeStep.
    
    Returns:
    
    the variable name
  - getVariableOperator
```
public VariableOperator getVariableOperator()
```
    Returns the variable operator for this AbstractRuntimeStep.
    
    Returns:
    
    the variable operator
  - getVariableIncrement
```
public java.lang.Number getVariableIncrement()
```
    Returns the variable increment for this AbstractRuntimeStep.
    
    Returns:
    
    the variable increment
  - getVariableValue
```
public java.lang.String getVariableValue()
```
    Returns the variable value for this AbstractRuntimeStep.
    
    Returns:
    
    the variable value
  - getOkExitCode
```
public java.lang.String getOkExitCode()
```
    Returns the exit code on success for this AbstractRuntimeStep.
    
    Returns:
    
    the exit code on success
  - getKoExitCode
```
public java.lang.String getKoExitCode()
```
    Returns the exit code on failure for this AbstractRuntimeStep.
    
    Returns:
    
    the exit code on failure
  - getFailureRetryNumber
```
public int getFailureRetryNumber()
```
    Returns the retry number on failure for this AbstractRuntimeStep.
    
    Returns:
    
    the retry number on failure
  - getFailureRetryDelay
```
public int getFailureRetryDelay()
```
    Returns the delay in milliseconds between retries on failure for this AbstractRuntimeStep.
    
    Returns:
    
    the delay between retries
  - getMaxErrorCount
```
public java.lang.Integer getMaxErrorCount()
```
    Returns the max error allowed for this AbstractRuntimeStep.
    
    Returns:
    
    the max error count
  - isMaxErrorCountAsPercentage
```
public boolean isMaxErrorCountAsPercentage()
```
    Indicates whether max error count value is of percentage representation.
    
    Returns:
    
    whether max error count value is of percentage
  - getTargetLogicalSchemaName
```
public java.lang.String getTargetLogicalSchemaName()
```
    Returns the target logical schema name for this AbstractRuntimeStep.
    
    Returns:
    
    the target logical schema name
  - getTargetModelCode
```
public java.lang.String getTargetModelCode()
```
    Returns the target model code for this AbstractRuntimeStep.
    
    Returns:
    
    the target model code
  - getTargetTableName
```
public java.lang.String getTargetTableName()
```
    Returns the target table name for this AbstractRuntimeStep.
    
    Returns:
    
    the target table name
  - getTargetResourceName
```
public java.lang.String getTargetResourceName()
```
    Returns the target resource name for this AbstractRuntimeStep.
    
    Returns:
    
    the target resource name
  - getLogMethod
```
public StepLoggingMethod getLogMethod()
```
    Returns the logging method for this AbstractRuntimeStep.
    
    Returns:
    
    the logging method
  - isOkExit
```
public boolean isOkExit()
```
    Returns true if exit required on success, false - otherwise.
    
    Returns:
    
    true if exit required on success, false - otherwise
  - isKoExit
```
public boolean isKoExit()
```
    Returns true if exit required on failure, false - otherwise.
    
    Returns:
    
    true if exit required on failure, false - otherwise
  - isCleanupOnError
```
public boolean isCleanupOnError()
```
    Returns true if cleanup tasks should be performed on error, false otherwise.
    
    Returns:
    
    if cleanup tasks should be performed.
  - setGenerationInfo
```
public void setGenerationInfo(GenerationInfo generationInfo)
```
    Sets the generation info for this step, which is the KM option information. The generation info data will be transformed into a string in XML format.
  - getGenerationInfo
```
public GenerationInfo getGenerationInfo()
```
    Returns the generation info for this step, which is the KM option information. The generation info string in XML format will be parsed back into a GenerationInfo object.
    
    Returns:
    
    generation info object.

Class AbstractRuntimeStep

Constructor Summary

Method Summary

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.IRepositoryEntity

Constructor Detail

AbstractRuntimeStep

Method Detail

getStepNumber

getName

getType

isContextForced

getContextCode

getVariableName

getVariableOperator

getVariableIncrement

getVariableValue

getOkExitCode

getKoExitCode

getFailureRetryNumber

getFailureRetryDelay

getMaxErrorCount

isMaxErrorCountAsPercentage

getTargetLogicalSchemaName

getTargetModelCode

getTargetTableName

getTargetResourceName

getLogMethod

isOkExit

isKoExit

isCleanupOnError

setGenerationInfo

getGenerationInfo