|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.odi.domain.support.BusinessObject oracle.odi.domain.support.AbstractRepositoryEntity oracle.odi.domain.project.Step
public abstract class Step
Abstract base class of package's steps.
All concrete step types will extend from the Step
class.
Nested Class Summary | |
---|---|
static class |
Step.LogLevel
Defines the log level for a Step . |
Field Summary | |
---|---|
static int |
NAME_MAX_LENGTH
Maximum length of the name property. |
Constructor Summary | |
---|---|
Step(OdiPackage pPackage,
java.lang.String pName)
Constructor that sets the parent OdiPackage and the step name. |
Method Summary | |
---|---|
int |
getFailureRetryDelay()
Returns the number of seconds before retrying this step when it has failed. |
int |
getFailureRetryNumber()
Returns the number of time this Step is re-tried and failed before
saying it has failed. |
java.io.Serializable |
getInternalId()
Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used. |
Step.LogLevel |
getLoglevel()
Gets the log type for this step when executed. |
java.lang.String |
getName()
Obtains this Step instance name. |
Step |
getNextStepAfterFailure()
Obtains the step that has to be executed after this one in case of failure. |
Step |
getNextStepAfterSuccess()
Returns the step that has to be executed after this one in case of success. |
OdiPackage |
getParentPackage()
Returns the parent package that holds this step. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
java.lang.Number |
getStepId()
Retrieves this Step instance internal identifier. |
boolean |
isFirstStep()
Returns whether this step is the first step to be executed in the package. |
void |
setFailureRetryDelay(int pFailureRetryDelay)
Sets the number of seconds before retrying when a step failed. |
void |
setFailureRetryNumber(int pFailureNumberRetry)
Sets the number of time this step is re-tried on failure before saying it has failed. |
void |
setLoglevel(Step.LogLevel pLoglevel)
Sets the log type for this step when executed. |
void |
setName(java.lang.String pName)
Sets the name of this step. |
void |
setNextStepAfterFailure(Step pNextStepAfterFailure)
Sets the Step that has to be executed after this one in case of failure. |
void |
setNextStepAfterSuccess(Step pNextStepAfterSuccess)
Sets the step that has to be executed after this one, if it succeeds. |
Methods inherited from class oracle.odi.domain.support.BusinessObject |
---|
clone |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int NAME_MAX_LENGTH
Constructor Detail |
---|
public Step(OdiPackage pPackage, java.lang.String pName)
OdiPackage
and the step name.
pPackage
- the package that will hold this steppName
- the name of the step to be created
java.lang.IllegalArgumentException
- if the package is null
or if the name is
null
, empty or longer than 436NAME_MAX_LENGTH
Method Detail |
---|
public int getFailureRetryDelay()
setFailureRetryDelay(int)
public int getFailureRetryNumber()
Step
is re-tried and failed before
saying it has failed.
setFailureRetryNumber(int)
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.
public Step.LogLevel getLoglevel()
setLoglevel(LogLevel)
public java.lang.String getName()
Step
instance name.
setName(String)
public Step getNextStepAfterFailure()
null
if it has to stopsetNextStepAfterFailure(Step)
public Step getNextStepAfterSuccess()
null
if it has to stopsetNextStepAfterSuccess(Step)
public OdiPackage getParentPackage()
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
public java.lang.Number getStepId()
Step
instance internal identifier.
public boolean isFirstStep()
true
if this is the first one, false
otherwisesetFirstStep(boolean)
public void setFailureRetryDelay(int pFailureRetryDelay)
By default, this property is set to 0 second.
pFailureRetryDelay
- the delay in second
java.lang.IllegalArgumentException
- if the parameter is negative.getFailureRetryDelay()
public void setFailureRetryNumber(int pFailureNumberRetry)
By default this property is set to 0 (zero).
pFailureNumberRetry
- the retry number
java.lang.IllegalArgumentException
- if the parameter is negative.getFailureRetryNumber()
public void setLoglevel(Step.LogLevel pLoglevel)
By default, log level applied to Step is Step.LogLevel.ALWAYS
.
pLoglevel
- the log levelpublic void setName(java.lang.String pName)
pName
- the name of the step
java.lang.IllegalArgumentException
- if the name is null or empty, or if it's longer than 436NAME_MAX_LENGTH
,
getName()
public void setNextStepAfterFailure(Step pNextStepAfterFailure)
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.
pNextStepAfterFailure
- the step after failure or null
if none
java.lang.IllegalArgumentException
- if it tries to link two steps from
different packagesgetNextStepAfterFailure()
public void setNextStepAfterSuccess(Step pNextStepAfterSuccess)
pNextStepAfterSuccess
- the step after success or null
if none
java.lang.IllegalArgumentException
- if it tries to link two steps from
different packagesgetNextStepAfterSuccess()
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |