Package com.almis.awe.model.entities.menu

Class Option

java.lang.Object

com.almis.awe.model.entities.Element

com.almis.awe.model.entities.screen.component.action.AbstractAction

com.almis.awe.model.entities.menu.Option

All Implemented Interfaces:

Copyable, XMLNode, Serializable

public class Option
extends AbstractAction

Option Class Used to parse the files in 'menu' folder with XStream Generates a menu option

Author:

Pablo GARCIA - 28/JUN/2010

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.almis.awe.model.entities.screen.component.action.AbstractAction

reload

Constructor Summary

Constructors

Constructor	Description
Option()

Method Summary

Modifier and Type	Method	Description
Option	copy()	Get a copy of this element
void	defineRelationship()	Define all options parent
String	getId()	Retrieve option id
List<Option>	getMenuScreenOptions()	Get all menu screen options
Option	getOptionByName(String optionName)	Search an initial option by name
Option	getOptionByScreen(String screen)	Search an initial option by screen name
List<Option>	getOptions()	Retrieve Option list
List<Option>	getOptionsByName(String optionName)	Search an initial option by name
String	getText()	Returns the option text
boolean	isDynamic()	Returns if option is visible or not
boolean	isInvisible()	Returns if option is invisible or not
boolean	isMenuScreen()	Returns if option is menu screen or not
boolean	isSeparator()	Returns if option is separator or not
boolean	isVisible()	Returns if option is visible or not
Option	setRestricted(boolean restricted)	Stores if option is restricted or not

Methods inherited from class com.almis.awe.model.entities.screen.component.action.AbstractAction

getActionValues, getElementKey, getServerActionConverter, getTemplate, isAsync, isSilent

Methods inherited from class com.almis.awe.model.entities.Element

addElement, generateHelpTemplate, generateHelpTemplate, generateTemplate, getChildrenByType, getElementList, getElementsById, getElementsByType, getElementsByType, getHelpTemplate, getReportStructure

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Option

public Option()

Method Details

copy

public Option copy()

Description copied from interface: Copyable

Get a copy of this element

Returns:

element copy

getText

public String getText()

Returns the option text

Returns:

Option text

setRestricted

public Option setRestricted(boolean restricted)

Stores if option is restricted or not

Parameters:

restricted - Option is restricted

isInvisible

public boolean isInvisible()

Returns if option is invisible or not

Returns:

Option is invisible

isSeparator

public boolean isSeparator()

Returns if option is separator or not

Returns:

Option is separator

isVisible

public boolean isVisible()

Returns if option is visible or not

Returns:

Option is visible

isDynamic

public boolean isDynamic()

Returns if option is visible or not

Returns:

Option is visible

isMenuScreen

public boolean isMenuScreen()

Returns if option is menu screen or not

Returns:

Option is visible

getOptions

public List<Option> getOptions()

Retrieve Option list

Returns:

Option list

getId

public String getId()

Retrieve option id

Returns:

Option id

getOptionByScreen

public Option getOptionByScreen(String screen)

Search an initial option by screen name

Parameters:

screen - Screen name

Returns:

Option found

getOptionByName

public Option getOptionByName(String optionName)

Search an initial option by name

Parameters:

optionName - Option name

Returns:

Option found

getOptionsByName

public List<Option> getOptionsByName(String optionName)

Search an initial option by name

Parameters:

optionName - Option name

Returns:

Option found

defineRelationship

public void defineRelationship()

Define all options parent

getMenuScreenOptions

public List<Option> getMenuScreenOptions()

Get all menu screen options