public interface IOpenToolParameter
Modifier and Type | Method and Description |
---|---|
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.
|
java.lang.String getCode()
setCode(String)
void setCode(java.lang.String pCode)
pCode
- - The new code for this parameter.getCode()
java.lang.String getHelp()
setHelp(String)
void setHelp(java.lang.String pHelp)
pHelp
- - A string containing the new help textgetHelp()
boolean isMandatory()
setMandatory(boolean)
void setMandatory(boolean pMandatory)
pMandatory
- - The new value of the flag.isMandatory()
java.lang.String getName()
setName(String)
void setName(java.lang.String pName)
pName
- - A string containing the new user-friendly name.getName()
java.lang.Object getValue()
setValue(Object)
void setValue(java.lang.Object pValue)
pValue
- - The new current value of the parameter.getValue()