oracle.odi.domain.project

Class Step

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.project.Step

All Implemented Interfaces:

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

Direct Known Subclasses:

StepDataStore, StepMapping, StepModel, StepOdiCommand, StepOsCommand, StepProcedure, StepSubModel, StepVariable

public abstract class Step
extends oracle.odi.domain.support.AbstractRepositoryEntity

Abstract base class of package's steps.

All concrete step types will extend from the Step class.

Since:

11.1.1.3.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Step.LogLevel Defines the log level for a Step.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_MAX_LENGTH Maximum length of the name property.

Constructor Summary

Constructors

Constructor and Description
Step(OdiPackage pPackage, java.lang.String pName) Constructor that sets the parent OdiPackage and the step name.

Method Summary

Modifier and Type	Method and Description
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.
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.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

Field Detail

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Maximum length of the name property.

See Also:

Constant Field Values

Constructor Detail

Step

public Step(OdiPackage pPackage,
            java.lang.String pName)

Constructor that sets the parent OdiPackage and the step name.

Parameters:

pPackage - the package that will hold this step

pName - the name of the step to be created

Throws:

DomainRuntimeException - if the package is null or if the name is null, empty or longer than 436

See Also:

NAME_MAX_LENGTH

Method Detail

getStepId

public java.lang.Number getStepId()

Retrieves this Step instance internal identifier.

Returns:

this step's ID

getFailureRetryNumber

public int getFailureRetryNumber()

Returns the number of time this Step is re-tried and failed before saying it has failed.

Returns:

retry number

See Also:

setFailureRetryNumber(int)

setFailureRetryNumber

public void setFailureRetryNumber(int pFailureNumberRetry)

Sets the number of time this step is re-tried on failure before saying it has failed. It can't be negative.

By default this property is set to 0 (zero).

Parameters:

pFailureNumberRetry - the retry number

Throws:

DomainRuntimeException - if the parameter is negative.

See Also:

getFailureRetryNumber()

getFailureRetryDelay

public int getFailureRetryDelay()

Returns the number of seconds before retrying this step when it has failed.

Returns:

a number of seconds

See Also:

setFailureRetryDelay(int)

setFailureRetryDelay

public void setFailureRetryDelay(int pFailureRetryDelay)

Sets the number of seconds before retrying when a step failed. Can't be negative.

By default, this property is set to 0 second.

Parameters:

pFailureRetryDelay - the delay in second

Throws:

DomainRuntimeException - if the parameter is negative.

See Also:

getFailureRetryDelay()

isFirstStep

public boolean isFirstStep()

Returns whether this step is the first step to be executed in the package.

Returns:

true if this is the first one, false otherwise

See Also:

setFirstStep(boolean)

getLoglevel

public Step.LogLevel getLoglevel()

Gets the log type for this step when executed.

Returns:

this step's log level

See Also:

setLoglevel(LogLevel)

setLoglevel

public void setLoglevel(Step.LogLevel pLoglevel)

Sets the log type for this step when executed.

By default, log level applied to Step is Step.LogLevel.ALWAYS.

Parameters:

pLoglevel - the log level

getNextStepAfterFailure

public Step getNextStepAfterFailure()

Obtains the step that has to be executed after this one in case of failure.

Returns:

the next step after failure or null if it has to stop

See Also:

setNextStepAfterFailure(Step)

setNextStepAfterFailure

public void setNextStepAfterFailure(Step pNextStepAfterFailure)

Sets the 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.

Parameters:

pNextStepAfterFailure - the step after failure or null if none

Throws:

DomainRuntimeException - if it tries to link two steps from different packages

See Also:

getNextStepAfterFailure()

getNextStepAfterSuccess

public Step getNextStepAfterSuccess()

Returns the step that has to be executed after this one in case of success.

Returns:

the next step after success or null if it has to stop

See Also:

setNextStepAfterSuccess(Step)

setNextStepAfterSuccess

public void setNextStepAfterSuccess(Step pNextStepAfterSuccess)

Sets the step that has to be executed after this one, if it succeeds. If no step was defined, it will stop after success.

Parameters:

pNextStepAfterSuccess - the step after success or null if none

Throws:

DomainRuntimeException - if it tries to link two steps from different packages

See Also:

getNextStepAfterSuccess()

getParentPackage

public OdiPackage getParentPackage()

Returns the parent package that holds this step.

Returns:

the parent package

getName

public java.lang.String getName()

Obtains this Step instance name.

Returns:

this step's name

See Also:

setName(String)

setName

public void setName(java.lang.String pName)

Sets the name of this step.

Parameters:

pName - the name of the step

Throws:

DomainRuntimeException - if the name is null or empty, or if it's longer than 436

See Also:

NAME_MAX_LENGTH, getName()

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.

Returns:

the persistence identity of this instance