oracle.odi.domain.project

Class StepProcedure

java.lang.Object

AbstractRepositoryEntity

oracle.odi.domain.project.Step

oracle.odi.domain.project.StepProcedure

All Implemented Interfaces:

IProcedureUser

public class StepProcedure
extends Step
implements IProcedureUser

Subclass of Step that will be used inside an OdiPackage to express execution of an OdiUserProcedure.

Since:

11.1.1.3.0

Nested Class Summary

Nested classes/interfaces inherited from class oracle.odi.domain.project.Step

Step.LogLevel

Field Summary

Fields inherited from class oracle.odi.domain.project.Step

NAME_MAX_LENGTH

Constructor Summary

Constructors

Constructor and Description
StepProcedure(OdiPackage pPackage, OdiUserProcedure pUserProcedure, java.lang.String pName) Constructor that sets the parent OdiPackage, the OdiUserProcedure upon which this Step is based and the step name.

Method Summary

Modifier and Type	Method and Description
java.lang.Number	getInstanceId() Return the internal identifier of the instance that is marked by this interface.
OdiUserProcedure	getProcedure() Returns the OdiUserProcedure upon which this Step is based.
java.util.List	getProcedureOptions() Return the values used in this step for the procedure options.
OdiUserProcedure	getProcedureShortcut() Internal use only.

Methods inherited from class oracle.odi.domain.project.Step

getFailureRetryDelay, getFailureRetryNumber, getInternalId, getLoglevel, getName, getNextStepAfterFailure, getNextStepAfterSuccess, getParentPackage, getSecurityContainer, getStepId, isFirstStep, setFailureRetryDelay, setFailureRetryNumber, setLoglevel, setName, setNextStepAfterFailure, setNextStepAfterSuccess

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StepProcedure

public StepProcedure(OdiPackage pPackage,
                     OdiUserProcedure pUserProcedure,
                     java.lang.String pName)

Constructor that sets the parent OdiPackage, the OdiUserProcedure upon which this Step is based and the step name.

Parameters:

pPackage - the package that will hold this step

pName - the name of the step to be created

pUserProcedure - the procedure to be executed when executing this step

Throws:

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

Method Detail

getProcedure

public OdiUserProcedure getProcedure()

Returns the OdiUserProcedure upon which this Step is based.

Returns:

an OdiUserProcedure object

getProcedureShortcut

public OdiUserProcedure getProcedureShortcut()

Internal use only. Get the user procedure shortcut associated with this step.

Returns:

OdiUserProcedure shortcut associated with this step.

getProcedureOptions

public java.util.List getProcedureOptions()

Return the values used in this step for the procedure options.

Returns:

an unmodifiable list of IOptionValue

getInstanceId

public java.lang.Number getInstanceId()

Description copied from interface: IProcedureUser

Return the internal identifier of the instance that is marked by this interface. (e.g. OdiModel implementation of that method return the modelId).

Specified by:

getInstanceId in interface IProcedureUser

Returns:

the ODI instance id.