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.
OdiSessionBlueprint}
,
Serialized FormConstructor and Description |
---|
OdiSessionBlueprintStep(int pStepNumber,
java.lang.String pName,
StepType pType)
FOR INTERNAL USE ONLY.
|
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.
|
OdiSessionBlueprintStep |
getNextStepAfterFailure()
Returns the next
OdiSessionBlueprintStep in sequence if this step failed
during execution. |
OdiSessionBlueprintStep |
getNextStepAfterSuccess()
Returns the next
OdiSessionBlueprintStep in successful execution sequence. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
OdiSessionBlueprint |
getSessionBlueprint()
Returns the enclosing
OdiSessionBlueprint . |
java.util.List |
getSessionBlueprintTasks()
Returns the unmodifiable collection of
OdiSessionBlueprintTask s, 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.
|
getContextCode, getFailureRetryDelay, getFailureRetryNumber, getKoExitCode, getLogMethod, getMaxErrorCount, getName, getOkExitCode, getStepNumber, getTargetLogicalSchemaName, getTargetModelCode, getTargetResourceName, getTargetTableName, getType, getVariableIncrement, getVariableName, getVariableOperator, getVariableValue, isCleanupOnError, isContextForced, isKoExit, isMaxErrorCountAsPercentage, isOkExit
equals, getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, hashCode, invokeCustomizedPersistenceMethodFor, toString
getName, getType
public OdiSessionBlueprintStep(int pStepNumber, java.lang.String pName, StepType pType)
Constructs the OdiSessionBlueprintStep
with specified step number, name and type.
pStepNumber
- step numberpName
- namepType
- typepublic OdiSessionBlueprint getSessionBlueprint()
OdiSessionBlueprint
.OdiSessionBlueprint
public OdiSessionBlueprintStep getNextStepAfterSuccess()
OdiSessionBlueprintStep
in successful execution sequence.OdiSessionBlueprintStep
after successpublic OdiSessionBlueprintStep getNextStepAfterFailure()
OdiSessionBlueprintStep
in sequence if this step failed
during execution.OdiSessionBlueprintStep
after failurepublic java.util.List getSessionBlueprintTasks()
OdiSessionBlueprintTask
s, this
OdiSessionBlueprintStep
consists of.OdiSessionBlueprintTask
spublic void addSessionBlueprintTask(OdiSessionBlueprintTask pSessionBlueprintTask)
OdiSessionBlueprintStep
.pSessionBlueprintTask
- blueprint task to addpublic void setName(java.lang.String pName)
public void setType(StepType pType)
public void setStepContextCode(java.lang.String pStepContextCode)
setStepContextCode
in interface IExecutableStep
public void setVariableName(java.lang.String pVariableName)
public void setVariableOperator(VariableOperator pVariableOperator)
public void setVariableIncrement(java.lang.Number pVariableIncrement)
public void setVariableValue(java.lang.String pVariableValue)
public void setNextStepAfterSuccess(OdiSessionBlueprintStep pNextStepAfterSuccess)
public void setOkExitCode(java.lang.String pOkExitCode)
public void setNextStepAfterFailure(OdiSessionBlueprintStep pNextStepAfterFailure)
public void setKoExitCode(java.lang.String pKoExitCode)
public void setOkExit(boolean pOkExit)
pOkExit
- if exit required on successpublic void setKoExit(boolean pKoExit)
pKoExit
- if exit required on failurepublic void setFailureRetryNumber(int pFailureRetryNumber)
public void setFailureRetryDelay(int pFailureRetryDelay)
public void setMaxErrorCount(java.lang.Integer pMaxErrorCount)
setMaxErrorCount
in interface IExecutableStep
public void setMaxErrorCountAsPercentage(boolean pMaxErrorCountAsPercentage)
setMaxErrorCountAsPercentage
in interface IExecutableStep
public void setTargetLogicalSchemaName(java.lang.String pTargetLogicalSchemaName)
setTargetLogicalSchemaName
in interface IExecutableStep
public void setTargetModelCode(java.lang.String pTargetModelCode)
setTargetModelCode
in interface IExecutableStep
public void setTargetTableName(java.lang.String pTargetTableName)
setTargetTableName
in interface IExecutableStep
public void setTargetResourceName(java.lang.String pTargetResourceName)
setTargetResourceName
in interface IExecutableStep
public void setForcedContextCode(java.lang.String pForcedContextCode)
setForcedContextCode
in interface IExecutableStep
public void setLogMethod(StepLoggingMethod pLogMethod)
setLogMethod
in interface IExecutableStep
public OdiSessionStepLog getSessionStepLog(OdiSession pSession, int pStepRunNumber)
OdiSessionStepLog
representing the log of this OdiSessionBlueprintStep
execution in the scope of specified OdiSession
for specified step run number.pSession
- sessionstepRunNumber
- step run number in cycle.OdiSessionStepLog
public java.io.Serializable getInternalId()
IRepositoryEntity
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.
getInternalId
in interface IRepositoryEntity
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
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)
createTask
in interface IExecutableStep
public IStepTask createCompositeTask(int taskIndex, TaskType taskType, IStepTask parentTask, java.lang.String taskName, java.lang.String taskName2, java.lang.String taskName3, IProcedureLine.LineType pLineType)
createCompositeTask
in interface IExecutableStep
public java.util.List getTasks()
getTasks
in interface IExecutableStep
public void setCleanupOnError(boolean pCleanupOnError)
pCleanupOnError
is true.setCleanupOnError
in interface IExecutableStep
pCleanupOnError
- if cleanup tasks should be performed on error.public void removeTask(IStepTask childTask)
removeTask
in interface IExecutableStep
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)
createTask
in interface IExecutableStep