oracle.odi.domain.adapter.project

Interface IProcedureOption

All Known Subinterfaces:

IProcedureOption

All Known Implementing Classes:

ProcedureOption

public interface IProcedureOption

An interface to represent an option of a procedure.

Method Summary

Modifier and Type	Method and Description
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.
int	getPosition() Obtains the position of this ProcedureOption in the list of options that belong to an IProcedure object.
java.lang.Number	getProcedureOptionId() Gets a numeric id for this object, for repositories that support numeric id.
java.lang.String	getProcedureOptionType() Obtains the type of this ProcedureOption.

Method Detail

getHelp

java.lang.String getHelp()

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

Returns:

help a String representing the help text

getDefaultOptionValue

java.lang.Object getDefaultOptionValue()

Obtains the default value set for this ProcedureOption.

Returns:

object that represents the default value.

See Also:

#setDefaultValue

getDefaultValue

java.lang.Object getDefaultValue()

Deprecated. Use getDefaultOptionValue

Obtains the default value set for this ProcedureOption.

Returns:

object that represents the default value.

See Also:

#setDefaultValue

getName

java.lang.String getName()

Obtains the name of this ProcedureOption.

Returns:

name of procedure option

See Also:

#setName

getDescription

java.lang.String getDescription()

Get the description.

Returns:

descripton of ProcedureOption

See Also:

#setDescription

getProcedureOptionType

java.lang.String getProcedureOptionType()

Obtains the type of this ProcedureOption.

Returns:

OptionType object for this procedure option. Can be SHORT_TEXT, LONG_TEXT, or CHECKBOX.

See Also:

#setOptionType

getPosition

int getPosition()

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

Returns:

position number

See Also:

#setPosition

getProcedureOptionId

java.lang.Number getProcedureOptionId()

Gets a numeric id for this object, for repositories that support numeric id. Otherwise returns null.

Returns:

numeric id or null if it is not supported.