public class ProcedureOption extends oracle.odi.domain.support.AbstractRepositoryEntity implements IProcedureOption
OdiProcedure
.
A ProcedureOption is used to parameterize an OdiProcedure.
ProcedureOption have a type the enum OptionType defines.
A ProcedureOption is an entity managed within the OdiProcedure ? OdiProcedureLine ? OdiProcedureLineCmd ? ProcedureOption aggregate.
A ProcedureOption has an ID that can be obtained from getProcedureOptionId() method call. This ID is assigned when an OdiProcedure is stored into design time repository. T his ID represents the identity of an OdiProcedure.
Equals / hashCode method are implemented according this identity.
The life cycle of a ProcedureOption start when it is created and added to the OdiProcedure it belongs. It can then be manipulated by the user and properties like name, help text, type and default value can be defined to fit user requirements.
User can also defines one or several options as generation criteria for some OdiProcedureLines. The life cycle ends when the ProcedureOption is removed from the OdiProcedure it belongs, or when the OdiProcedure owning the ProcedureOption is deleted.
OdiProcedure
,
Serialized FormModifier and Type | Class and Description |
---|---|
static class |
ProcedureOption.OptionType
ProcedureOption locally defines the Enum OptionType which represents the types a ProcedureOption can have.
|
Modifier and Type | Field and Description |
---|---|
static int |
DESCRIPTION_MAX_LENGTH
Maximum length of a procedure option description.
|
static int |
NAME_MAX_LENGTH
Maximum length of a procedure option name.
|
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.
|
java.lang.String |
getDescription()
Get the description.
|
java.lang.String |
getHelp()
Obtains help that is the actual long desription of this ProcedureOption.
|
java.io.Serializable |
getInternalId()
Internal.
|
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.
|
java.lang.Number |
getProcedureOptionId()
Internal.
|
java.lang.String |
getProcedureOptionType()
Obtains the type of this ProcedureOption.
|
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
void |
setChoiceOptionValues(java.util.Set optionValueSet)
Sets the option value Set for CHOICE optionType
|
void |
setConditionExpression(java.lang.String pCondExpr)
sets the condition expression of the procedure option
|
void |
setDefaultValue(java.lang.Object pValue)
Defines the default value for this ProcedureOption according to its type.
|
void |
setDefaultValue(java.lang.Object pValue,
java.util.Set optionValueSet)
Sets the Default Value for Procedure Option .
|
void |
setDescription(java.lang.String pDescription)
Set short description (<= 100 characters).
|
void |
setHelp(java.lang.String pHelp)
Defines the help as long description of this ProcedureOption.
|
void |
setName(java.lang.String pName)
Defines the name of this ProcedureOption to the given name.
|
void |
setOptionGroup(ProcedureOptionGroup optionGroup)
set the ProcedureOptionGroup for the procedure option
|
void |
setOptionType(ProcedureOption.OptionType pOptionType)
Defines the type of this ProcedureOption.
|
void |
setPosition(int pPosition)
Deprecated.
|
public static final int NAME_MAX_LENGTH
public static final int DESCRIPTION_MAX_LENGTH
public java.lang.String getHelp()
IProcedureOption
getHelp
in interface IProcedureOption
IProcedureOption.setHelp(java.lang.String)
public void setHelp(java.lang.String pHelp)
pHelp
- a String representing the help textgetHelp()
public java.lang.Number getProcedureOptionId()
public void setDefaultValue(java.lang.Object pValue)
pValue
- an object representing the default valueDomainRuntimeException
- if the given object is inconsistent with this ProcedureOption type.getDefaultValue()
public void setDefaultValue(java.lang.Object pValue, java.util.Set optionValueSet)
pValue
- an object representing the default valueoptionValueSet
- Set of option values valid for the option in case of CHOICE option type.DomainRuntimeException
- if the given object is inconsistent with this ProcedureOption type.public void setChoiceOptionValues(java.util.Set optionValueSet)
@Deprecated public java.lang.Object getDefaultValue()
IProcedureOption
getDefaultValue
in interface IProcedureOption
IProcedureOption.setDefaultValue(java.lang.Object, java.util.Set)
public java.lang.Object getDefaultOptionValue()
IProcedureOption
getDefaultOptionValue
in interface IProcedureOption
IProcedureOption.setDefaultValue(java.lang.Object, java.util.Set)
public java.util.Set getChoiceOptionValues()
public java.lang.String getName()
IProcedureOption
getName
in interface IProcedureOption
#setName
public void setName(java.lang.String pName)
pName
- name of procedure optionDomainRuntimeException
- if the given name is null or has more than NAME_MAX_LENGTH (400) charactersgetName()
public void setDescription(java.lang.String pDescription)
pDescription
- descripton of ProcedureOptionDomainRuntimeException
- if pDescription has more than DESCRIPTION_MAX_LENGTH characters.getDescription()
public java.lang.String getDescription()
IProcedureOption
getDescription
in interface IProcedureOption
IProcedureOption.setDescription(java.lang.String)
public ProcedureOption.OptionType getOptionType()
IProcedureOption
#setOptionType
public void setOptionType(ProcedureOption.OptionType pOptionType)
pOptionType
- OptionType object for this ProcedureOptionDomainRuntimeException
- if the given type is null.getOptionType()
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.io.Serializable getInternalId()
getInternalId
in interface IRepositoryEntity
public int getPosition()
IProcedureOption
getPosition
in interface IProcedureOption
IProcedureOption.setPosition(int)
@Deprecated public void setPosition(int pPosition)
IProcedureOption
public java.lang.String getProcedureOptionType()
IProcedureOption
getProcedureOptionType
in interface IProcedureOption
OptionType
object for this procedure option. Can be SHORT_TEXT, LONG_TEXT, or CHECKBOX.#setOptionType
public void setOptionGroup(ProcedureOptionGroup optionGroup)
optionGroup
- public ProcedureOptionGroup getOptionGroup()
public java.lang.String getConditionExpression()
public void setConditionExpression(java.lang.String pCondExpr)
pCondExpr
-