public interface IProcedureOption extends IProcedureOption
Modifier and Type | Method and Description |
---|---|
java.util.Set |
getChoiceOptionValues()
Return the Set
|
java.lang.String |
getConditionExpression()
returns the condition expression of the procedure option
|
java.lang.Object |
getDefaultOptionValue()
Obtains the default value set for this ProcedureOption.
|
java.lang.Object |
getDefaultValue()
Deprecated.
Use getDefaultOptionValue
|
java.lang.String |
getDescription()
Get the description.
|
java.lang.String |
getHelp()
Obtains help that is the actual long desription of this ProcedureOption.
|
java.lang.String |
getName()
Obtains the name of this ProcedureOption.
|
ProcedureOptionGroup |
getOptionGroup()
return the ProcedureOptionGroup of the procedure option
|
ProcedureOption.OptionType |
getOptionType()
Obtains the type of this ProcedureOption.
|
int |
getPosition()
Obtains the position of this ProcedureOption in the list of options that belong to an IProcedure object.
|
void |
setChoiceOptionValues(java.util.Set optionValueSet)
Sets the Option values list for CHOICE option type
|
void |
setConditionExpression(java.lang.String condExpr)
sets the condition expression for procedure option
|
void |
setDefaultValue(java.lang.Object pValue,
java.util.Set optionValueSet)
set the default value and option value Set
|
void |
setDescription(java.lang.String pDescription)
Set the description for this option.
|
void |
setHelp(java.lang.String pHelp)
Defines the help string for this procedure option..
|
void |
setOptionGroup(ProcedureOptionGroup optionGroup)
sets the procedure option group for procedure option
|
void |
setPosition(int pPosition)
Deprecated.
Options' positions should be managed by their owning procedure instance using
OdiProcedure.moveOptionBefore(ProcedureOption, ProcedureOption) , OdiProcedure.moveOptionAfter(ProcedureOption, ProcedureOption) |
getProcedureOptionType
void setHelp(java.lang.String pHelp)
pHelp
- a String representing the help textgetHelp()
java.lang.String getHelp()
getHelp
in interface IProcedureOption
setHelp(java.lang.String)
java.lang.Object getDefaultOptionValue()
getDefaultOptionValue
in interface IProcedureOption
setDefaultValue(java.lang.Object, java.util.Set)
java.lang.Object getDefaultValue()
getDefaultValue
in interface IProcedureOption
setDefaultValue(java.lang.Object, java.util.Set)
java.lang.String getName()
getName
in interface IProcedureOption
#setName
void setDescription(java.lang.String pDescription)
pDescription
- Description of IProcedureOptiongetDescription()
java.lang.String getDescription()
getDescription
in interface IProcedureOption
setDescription(java.lang.String)
ProcedureOption.OptionType getOptionType()
#setOptionType
void setPosition(int pPosition)
OdiProcedure.moveOptionBefore(ProcedureOption, ProcedureOption)
, OdiProcedure.moveOptionAfter(ProcedureOption, ProcedureOption)
pPosition
- int getPosition()
getPosition
in interface IProcedureOption
setPosition(int)
java.util.Set getChoiceOptionValues()
void setChoiceOptionValues(java.util.Set optionValueSet)
optionValueSet
- void setDefaultValue(java.lang.Object pValue, java.util.Set optionValueSet)
pValue
- optionValueSet
- java.lang.String getConditionExpression()
void setConditionExpression(java.lang.String condExpr)
condExpr
- ProcedureOptionGroup getOptionGroup()
void setOptionGroup(ProcedureOptionGroup optionGroup)
optionGroup
-