Package com.simplicite.util

Class EnumItem

java.lang.Object

com.simplicite.util.EnumItem

All Implemented Interfaces:

java.io.Serializable

public class EnumItem
extends java.lang.Object
implements java.io.Serializable

Enumeration item code/value/enabled

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EnumItem.EnumRendering	Code rendering of list of values

Constructor Summary

Constructors

Constructor	Description
EnumItem(EnumItem item, FieldStateTransition tran)	Clone item within a transition
EnumItem(java.lang.String code, java.lang.String value)	Constructor
EnumItem(java.lang.String code, java.lang.String value, boolean enabled)	Constructor
EnumItem(java.lang.String code, java.lang.String value, boolean enabled, int order)	Constructor
EnumItem(java.lang.String code, java.lang.String value, boolean enabled, int order, EnumItem.EnumRendering render)	Constructor
EnumItem(java.lang.String code, java.lang.String value, int order)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	exists(java.lang.String[] list)	Exists in a list of values ?
java.lang.String	getCode()	Unique code in a list
int	getOrder()	Item order
EnumItem.EnumRendering	getRendering()	Rendering
java.lang.String	getStateId()	State id if the item belongs to a state model
FieldStateTransition	getTransition()	State transition if the item belongs to a state model
java.lang.String	getValue()	Translated value in the user language
boolean	isEnabled()	Accessible
boolean	isReadOnlyFields()	State read only ?
boolean	isTerminal()	Terminal state ?
void	setCode(java.lang.String code)
void	setEnabled(boolean enabled)
void	setReadOnlyFields(boolean b)
void	setRendering(EnumItem.EnumRendering render)
void	setStateId(java.lang.String id)
void	setTerminal(boolean t)
void	setValue(int order)
void	setValue(java.lang.String value)
org.json.JSONObject	toJSONObject()	Generates a JSON object representation of the item
java.lang.String	toString()	Generates a string representation of the item

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EnumItem

public EnumItem(java.lang.String code,
                java.lang.String value)

Constructor

Parameters:

code - Code

value - Value

EnumItem

public EnumItem(java.lang.String code,
                java.lang.String value,
                int order)

Constructor

Parameters:

code - Code

value - Value

order - Order in list

EnumItem

public EnumItem(java.lang.String code,
                java.lang.String value,
                boolean enabled)

Constructor

Parameters:

code - Code

value - Value

enabled - Enabled?

EnumItem

public EnumItem(java.lang.String code,
                java.lang.String value,
                boolean enabled,
                int order)

Constructor

Parameters:

code - Code

value - Value

enabled - Enabled?

order - Order in list

EnumItem

public EnumItem(java.lang.String code,
                java.lang.String value,
                boolean enabled,
                int order,
                EnumItem.EnumRendering render)

Constructor

Parameters:

code - Code

value - Value

enabled - Enabled?

order - Order in list

render - Optional rendering

EnumItem

public EnumItem(EnumItem item,
                FieldStateTransition tran)

Clone item within a transition

Method Detail

getCode

public java.lang.String getCode()

Unique code in a list

Returns:

code

setCode

public void setCode(java.lang.String code)

getValue

public java.lang.String getValue()

Translated value in the user language

Returns:

translated value in the user language

setValue

public void setValue(java.lang.String value)

getOrder

public int getOrder()

Item order

Returns:

Order in list

setValue

public void setValue(int order)

getRendering

public EnumItem.EnumRendering getRendering()

Rendering

Returns:

Rendering

setRendering

public void setRendering(EnumItem.EnumRendering render)

isEnabled

public boolean isEnabled()

Accessible

Returns:

is Enabled ?

setEnabled

public void setEnabled(boolean enabled)

getStateId

public java.lang.String getStateId()

State id if the item belongs to a state model

Returns:

state id

setStateId

public void setStateId(java.lang.String id)

getTransition

public FieldStateTransition getTransition()

State transition if the item belongs to a state model

Returns:

state id

isTerminal

public boolean isTerminal()

Terminal state ?

Returns:

is terminal ?

setTerminal

public void setTerminal(boolean t)

isReadOnlyFields

public boolean isReadOnlyFields()

State read only ?

Returns:

is read only field ?

setReadOnlyFields

public void setReadOnlyFields(boolean b)

exists

public boolean exists(java.lang.String[] list)

Exists in a list of values ?

Parameters:

list - List

Returns:

exist in list ?

toJSONObject

public org.json.JSONObject toJSONObject()

Generates a JSON object representation of the item

Returns:

item as JSON object

toString

public java.lang.String toString()

Generates a string representation of the item

Overrides:

toString in class java.lang.Object

Returns:

item as string