Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.3.0)

E17060-01

oracle.odi.domain.project
Class StepProcedure

java.lang.Object
  extended by oracle.odi.domain.support.BusinessObject
      extended by oracle.odi.domain.support.AbstractRepositoryEntity
          extended by oracle.odi.domain.project.Step
              extended by oracle.odi.domain.project.StepProcedure
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, IRepositoryEntity, oracle.odi.domain.procusage.IProcedureUser

public class StepProcedure
extends Step
implements oracle.odi.domain.procusage.IProcedureUser

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

Since:
11.1.1.3.0
See Also:
Serialized Form

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
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
 java.lang.Number getInstanceId()
           
 OdiUserProcedure getProcedure()
          Returns the OdiUserProcedure upon which this Step is based.
 java.util.List<IOptionValue> getProcedureOptions()
          Return the values used in this step for the procedure options.
 
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 oracle.odi.domain.support.BusinessObject
clone
 
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:
java.lang.IllegalArgumentException - if the package is null, if the procedure is null or if the name is null, empty or longer than
Method Detail

getInstanceId

public java.lang.Number getInstanceId()
Specified by:
getInstanceId in interface oracle.odi.domain.procusage.IProcedureUser

getProcedure

public OdiUserProcedure getProcedure()
Returns the OdiUserProcedure upon which this Step is based.

Returns:
an OdiUserProcedure object

getProcedureOptions

public java.util.List<IOptionValue> getProcedureOptions()
Return the values used in this step for the procedure options.

Returns:
an unmodifiable list of IOptionValue

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.3.0)

E17060-01

Copyright © 2010, Oracle and/or its affiliates. All rights reserved.