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

E17060-01

oracle.odi.domain.runtime.ess.support
Class EssUtils

java.lang.Object
  extended by oracle.odi.domain.runtime.ess.support.EssUtils

public abstract class EssUtils
extends java.lang.Object

Helper class providing utility functions around ESS APIs.


Constructor Summary
EssUtils()
           
 
Method Summary
static java.lang.String getExecutionVariableName(java.lang.String pVariableParameter)
          Get execution variable name formatted for ODI from ESS variable name.
static oracle.as.scheduler.Filter getOdiJobDefinitionFilter()
          Get a filter for ODI job types.
static oracle.as.scheduler.Filter getOdiJobTypeFilter(boolean pIsAync, boolean pIsLoadPlan)
          Get filter for ODI job type.
static java.lang.String[] getParameterNames(java.lang.String pPrefix, oracle.as.scheduler.JobDefinition pJobDefinition)
          Get all parameter names with a given prefix.
static java.lang.String[] getParameterNames(java.lang.String pPrefix, oracle.as.scheduler.RequestParameters pRequestParameters)
          Get all parameter names with a given prefix.
static boolean getParameterValueAsBoolean(java.lang.String pParameter, oracle.as.scheduler.JobDefinition pJobDefinition, boolean pDefaultValue)
          Get a parameter as a boolean.
static boolean getParameterValueAsBoolean(java.lang.String pParameter, oracle.as.scheduler.RequestParameters pRequestParameters, boolean pDefaultValue)
          Get a parameter as a boolean.
static int getParameterValueAsInt(java.lang.String pParameter, oracle.as.scheduler.JobDefinition pJobDefinition, int pDefaultValue)
          Get a parameter as an int.
static int getParameterValueAsInt(java.lang.String pParameter, oracle.as.scheduler.RequestParameters pRequestParameters, int pDefaultValue)
          Get a parameter as an int.
static java.lang.String getParameterValueAsString(java.lang.String pParameter, oracle.as.scheduler.JobDefinition pJobDefinition)
          Get a parameter as a String.
static java.lang.String getParameterValueAsString(java.lang.String pParameter, oracle.as.scheduler.RequestParameters pRequestParameters)
          Get a parameter as a String.
static java.lang.String getVariableParameterName(java.lang.String pVariableName)
          Get variable name formatted for ESS from ODI variable name.
static void removeParameter(java.lang.String pParameter, oracle.as.scheduler.JobDefinition pJobDefinition)
          Remove a parameter from a job definition.
static void removeParameters(java.lang.String pPrefix, oracle.as.scheduler.JobDefinition pJobDefinition)
          Remove all parameters with a given prefix from a job definition.
static void setParameterValue(java.lang.String pParameter, java.lang.String pValue, boolean pReadOnly, oracle.as.scheduler.JobDefinition pJobDefinition)
          Set a parameter.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EssUtils

public EssUtils()
Method Detail

getExecutionVariableName

public static java.lang.String getExecutionVariableName(java.lang.String pVariableParameter)
Get execution variable name formatted for ODI from ESS variable name. Inverse of getVariableParameterName.

Parameters:
pVariableParameter - ESS parameter name
Returns:
variable name to use for ODI

getOdiJobDefinitionFilter

public static oracle.as.scheduler.Filter getOdiJobDefinitionFilter()
Get a filter for ODI job types.

Returns:
filter

getOdiJobTypeFilter

public static oracle.as.scheduler.Filter getOdiJobTypeFilter(boolean pIsAync,
                                                             boolean pIsLoadPlan)
Get filter for ODI job type.

Parameters:
pIsAync - async
pIsLoadPlan - loadplan
Returns:
filter

getParameterNames

public static java.lang.String[] getParameterNames(java.lang.String pPrefix,
                                                   oracle.as.scheduler.JobDefinition pJobDefinition)
Get all parameter names with a given prefix.

Parameters:
pPrefix - prefix
pJobDefinition - job definition
Returns:
array of parameter names

getParameterNames

public static java.lang.String[] getParameterNames(java.lang.String pPrefix,
                                                   oracle.as.scheduler.RequestParameters pRequestParameters)
Get all parameter names with a given prefix.

Parameters:
pPrefix - prefix
pRequestParameters - parameters
Returns:
array of parameter names

getParameterValueAsBoolean

public static boolean getParameterValueAsBoolean(java.lang.String pParameter,
                                                 oracle.as.scheduler.JobDefinition pJobDefinition,
                                                 boolean pDefaultValue)
Get a parameter as a boolean.

Parameters:
pParameter - parameter name
pJobDefinition - job definition
pDefaultValue - default value
Returns:
parameter value

getParameterValueAsBoolean

public static boolean getParameterValueAsBoolean(java.lang.String pParameter,
                                                 oracle.as.scheduler.RequestParameters pRequestParameters,
                                                 boolean pDefaultValue)
Get a parameter as a boolean.

Parameters:
pParameter - parameter name
pRequestParameters - parameters
pDefaultValue - default value
Returns:
parameter value

getParameterValueAsInt

public static int getParameterValueAsInt(java.lang.String pParameter,
                                         oracle.as.scheduler.JobDefinition pJobDefinition,
                                         int pDefaultValue)
Get a parameter as an int.

Parameters:
pParameter - parameter name
pJobDefinition - job definition
pDefaultValue - default value
Returns:
parameter value

getParameterValueAsInt

public static int getParameterValueAsInt(java.lang.String pParameter,
                                         oracle.as.scheduler.RequestParameters pRequestParameters,
                                         int pDefaultValue)
Get a parameter as an int.

Parameters:
pParameter - parameter name
pRequestParameters - parameters
pDefaultValue - default value
Returns:
parameter value

getParameterValueAsString

public static java.lang.String getParameterValueAsString(java.lang.String pParameter,
                                                         oracle.as.scheduler.JobDefinition pJobDefinition)
Get a parameter as a String.

Parameters:
pParameter - parameter name
pJobDefinition - job definition
Returns:
parameter value

getParameterValueAsString

public static java.lang.String getParameterValueAsString(java.lang.String pParameter,
                                                         oracle.as.scheduler.RequestParameters pRequestParameters)
Get a parameter as a String.

Parameters:
pParameter - parameter name
pRequestParameters - parameters
Returns:
parameter value

getVariableParameterName

public static java.lang.String getVariableParameterName(java.lang.String pVariableName)
Get variable name formatted for ESS from ODI variable name. Inverse of getExecutionVariableName.

Parameters:
pVariableName - ODI variable name
Returns:
variable name to use for ESS

removeParameter

public static void removeParameter(java.lang.String pParameter,
                                   oracle.as.scheduler.JobDefinition pJobDefinition)
Remove a parameter from a job definition.

Parameters:
pParameter - parameter to remove
pJobDefinition - job definition

removeParameters

public static void removeParameters(java.lang.String pPrefix,
                                    oracle.as.scheduler.JobDefinition pJobDefinition)
Remove all parameters with a given prefix from a job definition.

Parameters:
pPrefix - prefix of parameters to remove
pJobDefinition - job definition

setParameterValue

public static void setParameterValue(java.lang.String pParameter,
                                     java.lang.String pValue,
                                     boolean pReadOnly,
                                     oracle.as.scheduler.JobDefinition pJobDefinition)
Set a parameter.

Parameters:
pParameter - parameter name
pValue - parameter value
pReadOnly - read only
pJobDefinition - job definition

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.