oracle.odi.domain.project

Interface IProcedureOption

All Superinterfaces:

IProcedureOption

public interface IProcedureOption
extends IProcedureOption

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set	getChoiceOptionValues() Return the Set<String> of option values for CHOICE option type.
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<String> for CHOICE option type .
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)

Methods inherited from interface oracle.odi.domain.adapter.project.IProcedureOption

getProcedureOptionType

Method Detail

setHelp

void setHelp(java.lang.String pHelp)

Defines the help string for this procedure option..

Parameters:

pHelp - a String representing the help text

See Also:

getHelp()

getHelp

java.lang.String getHelp()

Obtains help that is the actual long desription of this ProcedureOption.

Specified by:

getHelp in interface IProcedureOption

Returns:

help a String representing the help text

See Also:

setHelp(java.lang.String)

getDefaultOptionValue

java.lang.Object getDefaultOptionValue()

Obtains the default value set for this ProcedureOption.

Specified by:

getDefaultOptionValue in interface IProcedureOption

Returns:

Object that represents the default value.

See Also:

setDefaultValue(java.lang.Object, java.util.Set)

getDefaultValue

java.lang.Object getDefaultValue()

Deprecated. Use getDefaultOptionValue

Obtains the default value set for this ProcedureOption.

Specified by:

getDefaultValue in interface IProcedureOption

Returns:

Object that represents the default value.

See Also:

setDefaultValue(java.lang.Object, java.util.Set)

getName

java.lang.String getName()

Obtains the name of this ProcedureOption.

Specified by:

getName in interface IProcedureOption

Returns:

Name of procedure option

See Also:

#setName

setDescription

void setDescription(java.lang.String pDescription)

Set the description for this option.

Parameters:

pDescription - Description of IProcedureOption

See Also:

getDescription()

getDescription

java.lang.String getDescription()

Get the description.

Specified by:

getDescription in interface IProcedureOption

Returns:

descripton of ProcedureOption

See Also:

setDescription(java.lang.String)

getOptionType

ProcedureOption.OptionType getOptionType()

Obtains the type of this ProcedureOption.

Returns:

OptionType object for this ProcedureOption

See Also:

#setOptionType

setPosition

void setPosition(int pPosition)

Deprecated. Options' positions should be managed by their owning procedure instance using OdiProcedure.moveOptionBefore(ProcedureOption, ProcedureOption), OdiProcedure.moveOptionAfter(ProcedureOption, ProcedureOption)

Set the position value for this option, within the list of options owned by the IProcedure object.

Parameters:

pPosition -

getPosition

int getPosition()

Obtains the position of this ProcedureOption in the list of options that belong to an IProcedure object.

Specified by:

getPosition in interface IProcedureOption

Returns:

position number

See Also:

setPosition(int)

getChoiceOptionValues

java.util.Set getChoiceOptionValues()

Return the Set<String> of option values for CHOICE option type.

Returns:

setChoiceOptionValues

void setChoiceOptionValues(java.util.Set optionValueSet)

Sets the Option values list for CHOICE option type

Parameters:

optionValueSet -

setDefaultValue

void setDefaultValue(java.lang.Object pValue,
                   java.util.Set optionValueSet)

set the default value and option value Set<String> for CHOICE option type . If used for other option type , the Set<String> should be null

Parameters:

pValue -

optionValueSet -

getConditionExpression

java.lang.String getConditionExpression()

returns the condition expression of the procedure option

Returns:

setConditionExpression

void setConditionExpression(java.lang.String condExpr)

sets the condition expression for procedure option

Parameters:

condExpr -

getOptionGroup

ProcedureOptionGroup getOptionGroup()

return the ProcedureOptionGroup of the procedure option

Returns:

setOptionGroup

void setOptionGroup(ProcedureOptionGroup optionGroup)

sets the procedure option group for procedure option

Parameters:

optionGroup -