oracle.odi.domain.runtime.session.blueprint

Class OdiSessionBlueprintStep

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.runtime.common.AbstractRuntimeStep

oracle.odi.domain.runtime.session.blueprint.OdiSessionBlueprintStep

All Implemented Interfaces:

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

public class OdiSessionBlueprintStep
extends AbstractRuntimeStep
implements IExecutableStep

OdiSessionBlueprintStep is the part of blueprint of ODI Session, representing Step of OdiScenario. Basically, it is the copy of OdiScenarioStep.

Life-cycle of OdiSessionBlueprintStep follows the life-cycle of enclosing OdiSessionBlueprint.

External SDK users should use this object for read-only purpose.

Since:

12.1

See Also:

OdiSessionBlueprint}, Serialized Form

Constructor Summary

Constructors

Constructor and Description
OdiSessionBlueprintStep(int pStepNumber, java.lang.String pName, StepType pType) FOR INTERNAL USE ONLY.

Method Summary

Modifier and Type	Method and Description
void	addSessionBlueprintTask(OdiSessionBlueprintTask pSessionBlueprintTask) Adds the task to this OdiSessionBlueprintStep.
IStepTask	createCompositeTask(int taskIndex, TaskType taskType, IStepTask parentTask, java.lang.String taskName, java.lang.String taskName2, java.lang.String taskName3, IProcedureLine.LineType pLineType)
IStepTask	createTask(int taskIndex, TaskType taskType, java.lang.String taskName, java.lang.String taskName2, java.lang.String taskName3, java.lang.String sourceCommand, boolean isSrcCommandEncrypted, java.lang.String srcCommandEncryptionKey, java.lang.String srcCommandEncryptionKeyVector, java.lang.String targetCommand, boolean isTrgCommandEncrypted, java.lang.String trgCommandEncryptionKey, java.lang.String trgCommandEncryptionKeyVector, OdiSessionTaskLog.IsolationLevel sourceIsolationLevel, OdiSessionTaskLog.IsolationLevel targetIsolationLevel)
IStepTask	createTask(int taskIndex, TaskType taskType, java.lang.String taskName, java.lang.String taskName2, java.lang.String taskName3, java.lang.String sourceCommand, java.lang.String targetCommand, OdiSessionTaskLog.IsolationLevel sourceIsolationLevel, OdiSessionTaskLog.IsolationLevel targetIsolationLevel)
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	getJagentLogicalSchemaName() retuns the Logical Schema Name set at execution time.
OdiSessionBlueprintStep	getNextStepAfterFailure() Returns the next OdiSessionBlueprintStep in sequence if this step failed during execution.
OdiSessionBlueprintStep	getNextStepAfterSuccess() Returns the next OdiSessionBlueprintStep in successful execution sequence.
java.lang.String	getScript()
OdiSessionBlueprint	getSessionBlueprint() Returns the enclosing OdiSessionBlueprint.
java.util.List	getSessionBlueprintTasks() Returns the unmodifiable collection of OdiSessionBlueprintTasks, this OdiSessionBlueprintStep consists of.
OdiSessionStepLog	getSessionStepLog(OdiSession pSession, int pStepRunNumber) Returns the OdiSessionStepLog representing the log of this OdiSessionBlueprintStep execution in the scope of specified OdiSession for specified step run number.
java.util.List	getTasks()
void	removeTask(IStepTask childTask)
void	setCleanupOnError(boolean pCleanupOnError) Cleanup tasks should be performed on error is pCleanupOnError is true.
void	setFailureRetryDelay(int pFailureRetryDelay) FOR INTERNAL USE ONLY.
void	setFailureRetryNumber(int pFailureRetryNumber) FOR INTERNAL USE ONLY.
void	setForcedContextCode(java.lang.String pForcedContextCode) FOR INTERNAL USE ONLY.
void	setKoExit(boolean pKoExit) FOR INTERNAL USE ONLY. Specifies if exit required on failure.
void	setKoExitCode(java.lang.String pKoExitCode) FOR INTERNAL USE ONLY.
void	setLogMethod(StepLoggingMethod pLogMethod) FOR INTERNAL USE ONLY.
void	setMaxErrorCount(java.lang.Integer pMaxErrorCount) FOR INTERNAL USE ONLY.
void	setMaxErrorCountAsPercentage(boolean pMaxErrorCountAsPercentage) FOR INTERNAL USE ONLY.
void	setName(java.lang.String pName) FOR INTERNAL USE ONLY.
void	setNextStepAfterFailure(OdiSessionBlueprintStep pNextStepAfterFailure) FOR INTERNAL USE ONLY.
void	setNextStepAfterSuccess(OdiSessionBlueprintStep pNextStepAfterSuccess) FOR INTERNAL USE ONLY.
void	setOkExit(boolean pOkExit) FOR INTERNAL USE ONLY. Specifies if exit required on success.
void	setOkExitCode(java.lang.String pOkExitCode) FOR INTERNAL USE ONLY.
void	setStepContextCode(java.lang.String pStepContextCode) FOR INTERNAL USE ONLY.
void	setTargetLogicalSchemaName(java.lang.String pTargetLogicalSchemaName) FOR INTERNAL USE ONLY.
void	setTargetModelCode(java.lang.String pTargetModelCode) FOR INTERNAL USE ONLY.
void	setTargetResourceName(java.lang.String pTargetResourceName) FOR INTERNAL USE ONLY.
void	setTargetTableName(java.lang.String pTargetTableName) FOR INTERNAL USE ONLY.
void	setType(StepType pType) FOR INTERNAL USE ONLY.
void	setVariableIncrement(java.lang.Number pVariableIncrement) FOR INTERNAL USE ONLY.
void	setVariableName(java.lang.String pVariableName) FOR INTERNAL USE ONLY.
void	setVariableOperator(VariableOperator pVariableOperator) FOR INTERNAL USE ONLY.
void	setVariableValue(java.lang.String pVariableValue) FOR INTERNAL USE ONLY.

Methods inherited from class oracle.odi.domain.runtime.common.AbstractRuntimeStep

getContextCode, getFailureRetryDelay, getFailureRetryNumber, getGenerationInfo, getKoExitCode, getLogMethod, getMaxErrorCount, getName, getOkExitCode, getStepNumber, getTargetLogicalSchemaName, getTargetModelCode, getTargetResourceName, getTargetTableName, getType, getVariableIncrement, getVariableName, getVariableOperator, getVariableValue, isCleanupOnError, isContextForced, isKoExit, isMaxErrorCountAsPercentage, isOkExit, setGenerationInfo

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.runtime.common.IExecutableStep

getGenerationInfo, getName, getType, setGenerationInfo

Constructor Detail

OdiSessionBlueprintStep

public OdiSessionBlueprintStep(int pStepNumber,
                               java.lang.String pName,
                               StepType pType)

FOR INTERNAL USE ONLY.

Constructs the OdiSessionBlueprintStep with specified step number, name and type.

Parameters:

pStepNumber - step number

pName - name

pType - type

Method Detail

getSessionBlueprint

public OdiSessionBlueprint getSessionBlueprint()

Returns the enclosing OdiSessionBlueprint.

Returns:

the enclosing OdiSessionBlueprint

getNextStepAfterSuccess

public OdiSessionBlueprintStep getNextStepAfterSuccess()

Returns the next OdiSessionBlueprintStep in successful execution sequence.

Returns:

the next OdiSessionBlueprintStep after success

getNextStepAfterFailure

public OdiSessionBlueprintStep getNextStepAfterFailure()

Returns the next OdiSessionBlueprintStep in sequence if this step failed during execution.

Returns:

the next OdiSessionBlueprintStep after failure

getSessionBlueprintTasks

public java.util.List getSessionBlueprintTasks()

Returns the unmodifiable collection of OdiSessionBlueprintTasks, this OdiSessionBlueprintStep consists of.

Returns:

list of contained OdiSessionBlueprintTasks

addSessionBlueprintTask

public void addSessionBlueprintTask(OdiSessionBlueprintTask pSessionBlueprintTask)

Adds the task to this OdiSessionBlueprintStep.

Parameters:

pSessionBlueprintTask - blueprint task to add

setName

public void setName(java.lang.String pName)

FOR INTERNAL USE ONLY.

setType

public void setType(StepType pType)

FOR INTERNAL USE ONLY.

setStepContextCode

public void setStepContextCode(java.lang.String pStepContextCode)

FOR INTERNAL USE ONLY.

Specified by:

setStepContextCode in interface IExecutableStep

setVariableName

public void setVariableName(java.lang.String pVariableName)

FOR INTERNAL USE ONLY.

setVariableOperator

public void setVariableOperator(VariableOperator pVariableOperator)

FOR INTERNAL USE ONLY.

setVariableIncrement

public void setVariableIncrement(java.lang.Number pVariableIncrement)

FOR INTERNAL USE ONLY.

setVariableValue

public void setVariableValue(java.lang.String pVariableValue)

FOR INTERNAL USE ONLY.

setNextStepAfterSuccess

public void setNextStepAfterSuccess(OdiSessionBlueprintStep pNextStepAfterSuccess)

FOR INTERNAL USE ONLY.

setOkExitCode

public void setOkExitCode(java.lang.String pOkExitCode)

FOR INTERNAL USE ONLY.

setNextStepAfterFailure

public void setNextStepAfterFailure(OdiSessionBlueprintStep pNextStepAfterFailure)

FOR INTERNAL USE ONLY.

setKoExitCode

public void setKoExitCode(java.lang.String pKoExitCode)

FOR INTERNAL USE ONLY.

setOkExit

public void setOkExit(boolean pOkExit)

FOR INTERNAL USE ONLY. Specifies if exit required on success.

Parameters:

pOkExit - if exit required on success

setKoExit

public void setKoExit(boolean pKoExit)

FOR INTERNAL USE ONLY. Specifies if exit required on failure.

Parameters:

pKoExit - if exit required on failure

setFailureRetryNumber

public void setFailureRetryNumber(int pFailureRetryNumber)

FOR INTERNAL USE ONLY.

setFailureRetryDelay

public void setFailureRetryDelay(int pFailureRetryDelay)

FOR INTERNAL USE ONLY.

setMaxErrorCount

public void setMaxErrorCount(java.lang.Integer pMaxErrorCount)

FOR INTERNAL USE ONLY.

Specified by:

setMaxErrorCount in interface IExecutableStep

setMaxErrorCountAsPercentage

public void setMaxErrorCountAsPercentage(boolean pMaxErrorCountAsPercentage)

FOR INTERNAL USE ONLY.

Specified by:

setMaxErrorCountAsPercentage in interface IExecutableStep

setTargetLogicalSchemaName

public void setTargetLogicalSchemaName(java.lang.String pTargetLogicalSchemaName)

FOR INTERNAL USE ONLY.

Specified by:

setTargetLogicalSchemaName in interface IExecutableStep

setTargetModelCode

public void setTargetModelCode(java.lang.String pTargetModelCode)

FOR INTERNAL USE ONLY.

Specified by:

setTargetModelCode in interface IExecutableStep

setTargetTableName

public void setTargetTableName(java.lang.String pTargetTableName)

FOR INTERNAL USE ONLY.

Specified by:

setTargetTableName in interface IExecutableStep

setTargetResourceName

public void setTargetResourceName(java.lang.String pTargetResourceName)

FOR INTERNAL USE ONLY.

Specified by:

setTargetResourceName in interface IExecutableStep

setForcedContextCode

public void setForcedContextCode(java.lang.String pForcedContextCode)

FOR INTERNAL USE ONLY.

Specified by:

setForcedContextCode in interface IExecutableStep

setLogMethod

public void setLogMethod(StepLoggingMethod pLogMethod)

FOR INTERNAL USE ONLY.

Specified by:

setLogMethod in interface IExecutableStep

getScript

public java.lang.String getScript()

Returns:

the script at the step/action level, e.g. Oozie.action config for Oozie sessions and returns null for ODI native sessions.

getJagentLogicalSchemaName

public java.lang.String getJagentLogicalSchemaName()

retuns the Logical Schema Name set at execution time.

Specified by:

getJagentLogicalSchemaName in interface IExecutableStep

Returns:

String LSchemaName

getSessionStepLog

public OdiSessionStepLog getSessionStepLog(OdiSession pSession,
                                           int pStepRunNumber)

Returns the OdiSessionStepLog representing the log of this OdiSessionBlueprintStep execution in the scope of specified OdiSession for specified step run number.

Parameters:

pSession - session

stepRunNumber - step run number in cycle.

Returns:

an OdiSessionStepLog

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

createTask

public IStepTask createTask(int taskIndex,
                            TaskType taskType,
                            java.lang.String taskName,
                            java.lang.String taskName2,
                            java.lang.String taskName3,
                            java.lang.String sourceCommand,
                            java.lang.String targetCommand,
                            OdiSessionTaskLog.IsolationLevel sourceIsolationLevel,
                            OdiSessionTaskLog.IsolationLevel targetIsolationLevel)

Specified by:

createTask in interface IExecutableStep

createCompositeTask

public IStepTask createCompositeTask(int taskIndex,
                                     TaskType taskType,
                                     IStepTask parentTask,
                                     java.lang.String taskName,
                                     java.lang.String taskName2,
                                     java.lang.String taskName3,
                                     IProcedureLine.LineType pLineType)

Specified by:

createCompositeTask in interface IExecutableStep

getTasks

public java.util.List getTasks()

Specified by:

getTasks in interface IExecutableStep

setCleanupOnError

public void setCleanupOnError(boolean pCleanupOnError)

Cleanup tasks should be performed on error is pCleanupOnError is true.

Specified by:

setCleanupOnError in interface IExecutableStep

Parameters:

pCleanupOnError - if cleanup tasks should be performed on error.

removeTask

public void removeTask(IStepTask childTask)

Specified by:

removeTask in interface IExecutableStep

createTask

public IStepTask createTask(int taskIndex,
                            TaskType taskType,
                            java.lang.String taskName,
                            java.lang.String taskName2,
                            java.lang.String taskName3,
                            java.lang.String sourceCommand,
                            boolean isSrcCommandEncrypted,
                            java.lang.String srcCommandEncryptionKey,
                            java.lang.String srcCommandEncryptionKeyVector,
                            java.lang.String targetCommand,
                            boolean isTrgCommandEncrypted,
                            java.lang.String trgCommandEncryptionKey,
                            java.lang.String trgCommandEncryptionKeyVector,
                            OdiSessionTaskLog.IsolationLevel sourceIsolationLevel,
                            OdiSessionTaskLog.IsolationLevel targetIsolationLevel)

Specified by:

createTask in interface IExecutableStep