Skip navigation links

oracle.odi.domain.project
Class ProcedureOption

java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.project.ProcedureOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity

public class ProcedureOption

extends oracle.odi.domain.support.AbstractRepositoryEntity

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.

Since:

11.1.1.3.0

See Also:

OdiProcedure, Serialized Form

Nested 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	getDefaultOptionValue() Obtains the default value set for this ProcedureOption.
java.lang.Object	getDefaultValue() Deprecated. use getDefualtOptionValue instead
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

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Maximum length of a procedure option name.

See Also:

Constant Field Values

DESCRIPTION_MAX_LENGTH

public static final int DESCRIPTION_MAX_LENGTH

Maximum length of a procedure option description.

See Also:

Constant Field Values

Method Detail

getHelp

public java.lang.String getHelp()

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

Returns:

help a String representing the help text

See Also:

setHelp(java.lang.String)

setHelp

public void setHelp(java.lang.String pHelp)

Defines the help as long description of this ProcedureOption.

Parameters:

pHelp - a String representing the help text

See Also:

getHelp()

getProcedureOptionId

public java.lang.Number getProcedureOptionId()

Internal.

Returns:

a Number object representing the procedure option id value.

setDefaultValue

public void setDefaultValue(java.lang.Object pValue)

Defines the default value for this ProcedureOption according to its type. By default, default value is set to null.

Parameters:

pValue - an object representing the default value

Throws:

DomainRuntimeException - if the given object is inconsistent with this ProcedureOption type.

See Also:

getDefaultValue()

getDefaultValue

@Deprecated
public java.lang.Object getDefaultValue()

Deprecated. use getDefualtOptionValue instead

Obtains the default value set for this ProcedureOption.

Returns:

Object that represents the default value.

See Also:

setDefaultValue(java.lang.Object)

getDefaultOptionValue

public java.lang.Object getDefaultOptionValue()

Obtains the default value set for this ProcedureOption.

Returns:

Object that represents the default value.

See Also:

setDefaultValue(java.lang.Object)

getName

public java.lang.String getName()

Obtains the name of this ProcedureOption.

Returns:

Name of procedure option

See Also:

setName(java.lang.String)

setName

public void setName(java.lang.String pName)

Defines the name of this ProcedureOption to the given name.

Parameters:

pName - name of procedure option

Throws:

DomainRuntimeException - if the given name is null or has more than NAME_MAX_LENGTH (400) characters

See Also:

getName()

setDescription

public void setDescription(java.lang.String pDescription)

Set short description (<= 100 characters).

Parameters:

pDescription - descripton of ProcedureOption

Throws:

DomainRuntimeException - if pDescription has more than DESCRIPTION_MAX_LENGTH characters.

See Also:

getDescription()

getDescription

public java.lang.String getDescription()

Get the short description.

Returns:

descripton of ProcedureOption

See Also:

setDescription(java.lang.String)

getOptionType

public ProcedureOption.OptionType getOptionType()

Obtains the type of this ProcedureOption.

Returns:

OptionType object for this ProcedureOption

See Also:

setOptionType(oracle.odi.domain.project.ProcedureOption.OptionType)

setOptionType

public void setOptionType(ProcedureOption.OptionType pOptionType)

Defines the type of this ProcedureOption. Types of ProcedureOption are defined by the enum type OptionType. By default, ProcedureOption type is set to OptionType.CHECKBOX.

Parameters:

pOptionType - OptionType object for this ProcedureOption

Throws:

DomainRuntimeException - if the given type is null.

See Also:

getOptionType()

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Returns:

container entity

getInternalId

public java.io.Serializable getInternalId()

Internal.

Returns:

the persistence identity of this instance

getPosition

public int getPosition()

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

Returns:

position number

See Also:

setPosition(int)

setPosition

public void setPosition(int pPosition)

Defines the position of this ProcedureOption in the list of options that belong to an OdiProcedure.

Parameters:

pPosition - position number

See Also:

getPosition()

Skip navigation links