Step
that will be used inside an OdiPackage
to express
execution of an OdiInterface
.public class StepInterface extends Step
Step.LogLevel
NAME_MAX_LENGTH
Constructor and Description |
---|
StepInterface(OdiPackage pPackage,
OdiInterface pInterface,
java.lang.String pName)
Deprecated.
Constructor that sets the parent
OdiPackage , the OdiInterface upon which this
Step is based, and the step name. |
Modifier and Type | Method and Description |
---|---|
StepMapping |
get12StepMappingObject()
Deprecated.
|
int |
getFailureRetryDelay()
Deprecated.
Returns the number of seconds before retrying this step when it has failed.
|
int |
getFailureRetryNumber()
Deprecated.
Returns the number of time this
Step is re-tried and failed before
saying it has failed. |
java.io.Serializable |
getInternalId()
Deprecated.
Provides a common getter for the persistence layer to obtain an identity,
irrespective of the actual type of identity used.
|
Step.LogLevel |
getLoglevel()
Deprecated.
Gets the log type for this step when executed.
|
java.lang.String |
getName()
Deprecated.
Obtains this
Step instance name. |
Step |
getNextStepAfterFailure()
Deprecated.
Obtains the step that has to be executed after this one in case of failure.
|
Step |
getNextStepAfterSuccess()
Deprecated.
Returns the step that has to be executed after this one in case of success.
|
OdiInterface |
getOdiInterface()
Deprecated.
Returns the
OdiInterface upon which is based this Step . |
OdiInterface |
getOdiInterfaceShortcut()
Deprecated.
Internal use only
|
OdiPackage |
getParentPackage()
Deprecated.
Returns the parent package that holds this step.
|
IRepositoryEntity |
getSecurityContainer()
Deprecated.
Define a generic way to retrieve container for entities.
|
java.lang.Number |
getStepId()
Deprecated.
Retrieves this
Step instance internal identifier. |
boolean |
isFirstStep()
Deprecated.
Returns whether this step is the first step to be executed in the
package.
|
static StepInterface |
retrieveStepInterface(StepMapping stepMapping,
OdiInterface odiInterface)
Deprecated.
|
void |
setFailureRetryDelay(int pFailureRetryDelay)
Deprecated.
Sets the number of seconds before retrying when a step failed.
|
void |
setFailureRetryNumber(int pFailureNumberRetry)
Deprecated.
Sets the number of time this step is re-tried on failure before saying it has failed.
|
void |
setLoglevel(Step.LogLevel pLoglevel)
Deprecated.
Sets the log type for this step when executed.
|
void |
setName(java.lang.String pName)
Deprecated.
Sets the name of this step.
|
void |
setNextStepAfterFailure(Step pNextStepAfterFailure)
Deprecated.
Sets the
Step that has to be executed after this one in case of failure. |
void |
setNextStepAfterSuccess(Step pNextStepAfterSuccess)
Deprecated.
Sets the step that has to be executed after this one, if it succeeds.
|
public StepInterface(OdiPackage pPackage, OdiInterface pInterface, java.lang.String pName)
OdiPackage
, the OdiInterface
upon which this
Step
is based, and the step name.pPackage
- the package that will hold this steppInterface
- the declared interfacepName
- the name of the step to be createdDomainRuntimeException
- if the package or interface is null, or if
the name is null, empty or longer than public static StepInterface retrieveStepInterface(StepMapping stepMapping, OdiInterface odiInterface)
public OdiInterface getOdiInterface()
OdiInterface
upon which is based this Step
.OdiInterface
objectpublic OdiInterface getOdiInterfaceShortcut()
public StepMapping get12StepMappingObject()
public java.lang.Number getStepId()
Step
Step
instance internal identifier.public int getFailureRetryNumber()
Step
Step
is re-tried and failed before
saying it has failed.getFailureRetryNumber
in class Step
Step.setFailureRetryNumber(int)
public void setFailureRetryNumber(int pFailureNumberRetry)
Step
By default this property is set to 0 (zero).
setFailureRetryNumber
in class Step
pFailureNumberRetry
- the retry numberStep.getFailureRetryNumber()
public int getFailureRetryDelay()
Step
getFailureRetryDelay
in class Step
Step.setFailureRetryDelay(int)
public void setFailureRetryDelay(int pFailureRetryDelay)
Step
By default, this property is set to 0 second.
setFailureRetryDelay
in class Step
pFailureRetryDelay
- the delay in secondStep.getFailureRetryDelay()
public boolean isFirstStep()
Step
isFirstStep
in class Step
true
if this is the first one, false
otherwiseStep.setFirstStep(boolean)
public Step.LogLevel getLoglevel()
Step
getLoglevel
in class Step
Step.setLoglevel(LogLevel)
public void setLoglevel(Step.LogLevel pLoglevel)
Step
By default, log level applied to Step is Step.LogLevel.ALWAYS
.
setLoglevel
in class Step
pLoglevel
- the log levelpublic Step getNextStepAfterFailure()
Step
getNextStepAfterFailure
in class Step
null
if it has to stopStep.setNextStepAfterFailure(Step)
public void setNextStepAfterFailure(Step pNextStepAfterFailure)
Step
Step
that has to be executed after this one in case of failure.
If no step is defined, the OdiPackage
will stop after having failed.
The next step must be part of the same package.
setNextStepAfterFailure
in class Step
pNextStepAfterFailure
- the step after failure or null
if noneStep.getNextStepAfterFailure()
public Step getNextStepAfterSuccess()
Step
getNextStepAfterSuccess
in class Step
null
if it has to stopStep.setNextStepAfterSuccess(Step)
public void setNextStepAfterSuccess(Step pNextStepAfterSuccess)
Step
setNextStepAfterSuccess
in class Step
pNextStepAfterSuccess
- the step after success or null
if noneStep.getNextStepAfterSuccess()
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
getSecurityContainer
in class Step
public OdiPackage getParentPackage()
Step
getParentPackage
in class Step
public java.lang.String getName()
Step
Step
instance name.getName
in class Step
Step.setName(String)
public void setName(java.lang.String pName)
Step
setName
in class Step
pName
- the name of the stepStep.NAME_MAX_LENGTH
,
Step.getName()
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
getInternalId
in class Step