Package com.polarion.platform.persistence.spi

Class ConstantEnumOption

java.lang.Object

com.polarion.platform.persistence.spi.ConstantEnumOption

All Implemented Interfaces:

IEnumOption

public class ConstantEnumOption
extends Object
implements IEnumOption

Author:

POLARION SOFTWARE

Field Summary

Fields inherited from interface com.polarion.platform.persistence.IEnumOption

PROPERTY_KEY_COLOR, PROPERTY_KEY_DEFAULT, PROPERTY_KEY_DESCRIPTION, PROPERTY_KEY_HIDDEN, PROPERTY_KEY_ICON_URL, PROPERTY_KEY_UI_LINK, PROPERTY_KEY_URI

Constructor Summary

Constructors

Constructor	Description
ConstantEnumOption()

Method Summary

Modifier and Type	Method	Description
void	addProperty(OptionProperty optionProperty)
boolean	equals(Object obj)	Two options are equal, if they have both the same enumId and id.
String	getEnumId()
String	getId()
String	getName()
Properties	getProperties()
String	getProperty(String key)	This method allows the system to pass through some specific attributes for different enumerations, like colors of texts, or url of icons.
int	getSequenceNumber()
int	hashCode()
boolean	isDefault()
boolean	isHidden()	Indicates that the option should be hidden from selectors in UI
boolean	isPhantom()	Phantom options represent values that are not part of the options available in the enumeration (but probably once were).
void	setDefault(boolean def)
void	setEnumId(String enumId)
void	setId(String id)
void	setName(String name)
void	setNumber(int number)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ConstantEnumOption

public ConstantEnumOption()

Method Details

getEnumId

public String getEnumId()

Specified by:

getEnumId in interface IEnumOption

Returns:

The ID of enumeration this option belongs to.

getId

public String getId()

Specified by:

getId in interface IEnumOption

getName

public String getName()

Specified by:

getName in interface IEnumOption

getSequenceNumber

public int getSequenceNumber()

Specified by:

getSequenceNumber in interface IEnumOption

Returns:

The sequence number as defined or 0 if not defined.

equals

public boolean equals(Object obj)

Two options are equal, if they have both the same enumId and id.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getProperty

public String getProperty(String key)

Description copied from interface: IEnumOption

This method allows the system to pass through some specific attributes for different enumerations, like colors of texts, or url of icons.

Specified by:

getProperty in interface IEnumOption

Returns:

the String property value

getProperties

public Properties getProperties()

Specified by:

getProperties in interface IEnumOption

setEnumId

public void setEnumId(String enumId)

Parameters:

enumId - the enumId to set

setId

public void setId(String id)

Parameters:

id - the id to set

setName

public void setName(String name)

Parameters:

name - the name to set

setNumber

public void setNumber(int number)

Parameters:

number - the number to set

setDefault

public void setDefault(boolean def)

Parameters:

def - the boolean to set

addProperty

public void addProperty(OptionProperty optionProperty)

isPhantom

public boolean isPhantom()

Description copied from interface: IEnumOption

Phantom options represent values that are not part of the options available in the enumeration (but probably once were). They usually contain no other data than the ID.

Specified by:

isPhantom in interface IEnumOption

isDefault

public boolean isDefault()

Specified by:

isDefault in interface IEnumOption

isHidden

public boolean isHidden()

Description copied from interface: IEnumOption

Indicates that the option should be hidden from selectors in UI

Specified by:

isHidden in interface IEnumOption

Since:

3.6.0