OpenToolParameter (Oracle Data Integrator Open Tools Java API Reference)

This class provides a basic implementation for IOpenToolParameter and thus can be used to define parameters for IOpenTool objects. See the documentation for the IOpenToolParameter class for further details.

Constructor Summary
`OpenToolParameter(java.lang.String pCode)` Creates an OpenToolParameter object by only specifying its parameter code.
`OpenToolParameter(java.lang.String pCode, java.lang.String pName)` Creates an OpenToolParameter object by specifying only the parameter code and user-friendly name.
`OpenToolParameter(java.lang.String pCode, java.lang.String pName, java.lang.String pHelp, boolean pMandatory)` Constructs an OpenToolParameter object by specifying the parameter code, its user-friendly name, a help text, and whether or not it is mandatory.

Method Summary
`java.lang.String`	`getCode()` Returns the code (the actual word used on a command line) that represents the parameter.
`java.lang.String`	`getHelp()` Returns a string describing what the parameter does.
`java.lang.String`	`getName()` Returns the user-friendly name of the parameter.
`java.lang.Object`	`getValue()` Returns the value of this parameter previously set by setValue().
`boolean`	`isMandatory()` Returns a boolean that defines whether this parameter must be present for a command that calls the Open Tool to be valid.
`void`	`setCode(java.lang.String pCode)` Sets the parameter code.
`void`	`setHelp(java.lang.String pHelp)` Sets the help text which describes what the parameter does.
`void`	`setMandatory(boolean pMandatory)` Sets the flag that specifies whether this parameter is mandatory or not.
`void`	`setName(java.lang.String pName)` Sets the user-friendly name of the parameter.
`void`	`setValue(java.lang.Object pValue)` Sets the current value of this parameter.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

OpenToolParameter

public OpenToolParameter(java.lang.String pCode,
                         java.lang.String pName,
                         java.lang.String pHelp,
                         boolean pMandatory)

Constructs an OpenToolParameter object by specifying the parameter code, its user-friendly name, a help text, and whether or not it is mandatory.

Parameters:: pCode - - The code for the parameter as it will appear on a command line. Must not contain any spaces, minus signs (-) or equals signs (=).; pName - - The user friendly name for the parameter.; pHelp - - The help text for the parameter.; pMandatory - - Sets the mandatory flag for the parameter.

OpenToolParameter

public OpenToolParameter(java.lang.String pCode,
                         java.lang.String pName)

Creates an OpenToolParameter object by specifying only the parameter code and user-friendly name. The help text will be set to the default "no help for parameter" text, and the parameter will be mandatory.

Parameters:: pCode - - The code for the parameter as it will appear on a command line. Must not contain any spaces, minus signs (-) or equals signs (=).; pName - - The user friendly name for the parameter.

OpenToolParameter

public OpenToolParameter(java.lang.String pCode)

Creates an OpenToolParameter object by only specifying its parameter code. The name will be the same as its code, the help text will be set to the default "no help for parameter" text, and the parameter will be mandatory.

Parameters:: pCode - - The code for the parameter as it will appear on a command line. Must not contain any spaces, minus signs (-) or equals signs (=).

Method Detail