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

E17060-01

oracle.odi.domain.project
Class StepOdiCommand

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.StepOdiCommand
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, IRepositoryEntity

public class StepOdiCommand
extends Step

Subclass of Step representing a step that contains an ODI command.

Such step will be used inside an OdiPackage to express execution of an ODI tool into a string command.

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
StepOdiCommand(OdiPackage pPackage, java.lang.String pName)
          Constructor that sets the parent OdiPackage and the step name.
 
Method Summary
 Expression getCommandExpression()
          Returns the expression that define the ODI command (aka tool) to be executed when executing this step.
 void setCommandExpression(Expression pCommand)
          Sets the expression that defines the ODI command (aka tool) to be executed when executing this step.
 void setCommandExpression(java.lang.String pCommand, GlobalExpressionContext pGlobalContext)
          Sets the expression that defines the ODI command (aka tool) to be executed when executing this step.
 
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

StepOdiCommand

public StepOdiCommand(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:
java.lang.IllegalArgumentException - if the package is null or if the name is null, empty or longer than
Method Detail

getCommandExpression

public Expression getCommandExpression()
Returns the expression that define the ODI command (aka tool) to be executed when executing this step.

Read documentation about ODI package tools for more information.

Returns:
an Expression object
See Also:
setCommandExpression(Expression)

setCommandExpression

public void setCommandExpression(Expression pCommand)
Sets the expression that defines the ODI command (aka tool) to be executed when executing this step.

Read documentation about ODI package tools for more information.

Parameters:
pCommand - the expression
Throws:
java.lang.IllegalArgumentException - if the command is not an ODI Tool command.
See Also:
setCommandExpression(String, GlobalExpressionContext), getCommandExpression()

setCommandExpression

public void setCommandExpression(java.lang.String pCommand,
                                 GlobalExpressionContext pGlobalContext)
Sets the expression that defines the ODI command (aka tool) to be executed when executing this step.

Read documentation about ODI package tools for more information.

Parameters:
pCommand - the expression
pGlobalContext - the global context that will be used to reference global ODI objects (like variables, sequences...)
Throws:
java.lang.IllegalArgumentException - if the command is not an ODI Tool command.
See Also:
setCommandExpression(Expression), getCommandExpression()

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.