|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.odi.domain.support.BusinessObject oracle.odi.domain.support.AbstractRepositoryEntity oracle.odi.domain.project.ProcedureOption
public class ProcedureOption
Represents the option for an 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 FormNested Class Summary | |
---|---|
static class |
ProcedureOption.OptionType
ProcedureOption locally defines the Enum OptionType which represents the types a ProcedureOption can have. |
Field Summary | |
---|---|
static int |
DESCRIPTION_MAX_LENGTH
Maximum length of a procedure option description. |
static int |
NAME_MAX_LENGTH
Maximum length of a procedure option name. |
Method Summary | |
---|---|
java.lang.Object |
getDefaultValue()
Obtains the default value set for this ProcedureOption. |
java.lang.String |
getDescription()
Get the short 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. |
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 OdiProcedure. |
java.lang.Number |
getProcedureOptionId()
Internal. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
void |
setDefaultValue(java.lang.Object pValue)
Defines the default value for this ProcedureOption according to its type. |
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 |
setOptionType(ProcedureOption.OptionType pOptionType)
Defines the type of this ProcedureOption. |
void |
setPosition(int pPosition)
Defines the position of this ProcedureOption in the list of options that belong to an OdiProcedure. |
Methods inherited from class oracle.odi.domain.support.BusinessObject |
---|
clone |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DESCRIPTION_MAX_LENGTH
public static final int NAME_MAX_LENGTH
Method Detail |
---|
public java.lang.Object getDefaultValue()
setDefaultValue(java.lang.Object)
public java.lang.String getDescription()
setDescription(java.lang.String)
public java.lang.String getHelp()
setHelp(java.lang.String)
public java.io.Serializable getInternalId()
public java.lang.String getName()
setName(java.lang.String)
public ProcedureOption.OptionType getOptionType()
setOptionType(oracle.odi.domain.project.ProcedureOption.OptionType)
public int getPosition()
setPosition(int)
public java.lang.Number getProcedureOptionId()
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
public void setDefaultValue(java.lang.Object pValue)
pValue
- an object representing the default value
java.lang.IllegalArgumentException
- if the given object is inconsistent with this ProcedureOption type.getDefaultValue()
public void setDescription(java.lang.String pDescription)
pDescription
- descripton of ProcedureOption
java.lang.IllegalArgumentException
- if pDescription has more than DESCRIPTION_MAX_LENGTH characters.getDescription()
public void setHelp(java.lang.String pHelp)
pHelp
- a String representing the help textgetHelp()
public void setName(java.lang.String pName)
pName
- name of procedure option
java.lang.IllegalArgumentException
- if the given name is null or has more than NAME_MAX_LENGTH (400) charactersgetName()
public void setOptionType(ProcedureOption.OptionType pOptionType)
pOptionType
- OptionType object for this ProcedureOption
java.lang.IllegalArgumentException
- if the given type is null.getOptionType()
public void setPosition(int pPosition)
pPosition
- position numbergetPosition()
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |