|
Oracle© Data Integrator Open Tools Java API Reference 11g Release 1 (11.1.1.3.0) E17061-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.odi.sdk.opentools.OpenToolParameter
public class OpenToolParameter
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 |
---|
public OpenToolParameter(java.lang.String pCode)
pCode
- - The code for the parameter as it will appear on a command line. Must not contain any spaces, minus signs (-) or equals signs (=).public OpenToolParameter(java.lang.String pCode, java.lang.String pName)
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.public OpenToolParameter(java.lang.String pCode, java.lang.String pName, java.lang.String pHelp, boolean pMandatory)
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.Method Detail |
---|
public java.lang.String getCode()
IOpenToolParameter
getCode
in interface IOpenToolParameter
IOpenToolParameter.getCode()
public java.lang.String getHelp()
IOpenToolParameter
getHelp
in interface IOpenToolParameter
IOpenToolParameter.getHelp()
public java.lang.String getName()
IOpenToolParameter
getName
in interface IOpenToolParameter
IOpenToolParameter.getName()
public java.lang.Object getValue()
IOpenToolParameter
getValue
in interface IOpenToolParameter
IOpenToolParameter.getValue()
public boolean isMandatory()
IOpenToolParameter
isMandatory
in interface IOpenToolParameter
IOpenToolParameter.isMandatory()
public void setCode(java.lang.String pCode)
IOpenToolParameter
setCode
in interface IOpenToolParameter
pCode
- - The new code for this parameter.IOpenToolParameter.setCode(java.lang.String)
public void setHelp(java.lang.String pHelp)
IOpenToolParameter
setHelp
in interface IOpenToolParameter
pHelp
- - A string containing the new help textIOpenToolParameter.setHelp(java.lang.String)
public void setMandatory(boolean pMandatory)
IOpenToolParameter
setMandatory
in interface IOpenToolParameter
pMandatory
- - The new value of the flag.IOpenToolParameter.setMandatory(boolean)
public void setName(java.lang.String pName)
IOpenToolParameter
setName
in interface IOpenToolParameter
pName
- - A string containing the new user-friendly name.IOpenToolParameter.setName(java.lang.String)
public void setValue(java.lang.Object pValue)
IOpenToolParameter
setValue
in interface IOpenToolParameter
pValue
- - The new current value of the parameter.IOpenToolParameter.setValue(java.lang.Object)
|
Oracle© Data Integrator Open Tools Java API Reference 11g Release 1 (11.1.1.3.0) E17061-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |