org.apache.openejb.jee

Class FacesNavigationRule

java.lang.Object

org.apache.openejb.jee.FacesNavigationRule

public class FacesNavigationRule
extends Object

web-facesconfig_2_0.xsd

Java class for faces-config-navigation-ruleType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="faces-config-navigation-ruleType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://java.sun.com/xml/ns/javaee}descriptionGroup"/>
         <element name="from-view-id" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="navigation-case" type="{http://java.sun.com/xml/ns/javaee}faces-config-navigation-caseType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="navigation-rule-extension" type="{http://java.sun.com/xml/ns/javaee}faces-config-navigation-rule-extensionType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected TextMap	description
protected TextMap	displayName
protected String	fromViewId
protected LocalCollection<Icon>	icon
protected String	id
protected List<FacesNavigationCase>	navigationCase
protected List<FacesNavigationRuleExtension>	navigationRuleExtension

Constructor Summary

Constructors

Constructor and Description
FacesNavigationRule()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription()
Text[]	getDescriptions()
String	getDisplayName()
Text[]	getDisplayNames()
String	getFromViewId() Gets the value of the fromViewId property.
Icon	getIcon()
Map<String,Icon>	getIconMap()
Collection<Icon>	getIcons()
String	getId() Gets the value of the id property.
List<FacesNavigationCase>	getNavigationCase() Gets the value of the navigationCase property.
List<FacesNavigationRuleExtension>	getNavigationRuleExtension() Gets the value of the navigationRuleExtension property.
void	setDescriptions(Text[] text)
void	setDisplayNames(Text[] text)
void	setFromViewId(String value) Sets the value of the fromViewId property.
void	setId(String value) Sets the value of the id property.

Methods inherited from class java.lang.Object

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

Field Detail

description

protected TextMap description

displayName

protected TextMap displayName

icon

protected LocalCollection<Icon> icon

fromViewId

protected String fromViewId

navigationCase

protected List<FacesNavigationCase> navigationCase

navigationRuleExtension

protected List<FacesNavigationRuleExtension> navigationRuleExtension

id

protected String id

Constructor Detail

FacesNavigationRule

public FacesNavigationRule()

Method Detail

getDescriptions

public Text[] getDescriptions()

setDescriptions

public void setDescriptions(Text[] text)

getDescription

public String getDescription()

getDisplayNames

public Text[] getDisplayNames()

setDisplayNames

public void setDisplayNames(Text[] text)

getDisplayName

public String getDisplayName()

getIcons

public Collection<Icon> getIcons()

getIconMap

public Map<String,Icon> getIconMap()

getIcon

public Icon getIcon()

getFromViewId

public String getFromViewId()

Gets the value of the fromViewId property.

Returns:

possible object is String

setFromViewId

public void setFromViewId(String value)

Sets the value of the fromViewId property.

Parameters:

value - allowed object is String

getNavigationCase

public List<FacesNavigationCase> getNavigationCase()

Gets the value of the navigationCase property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the navigationCase property.

For example, to add a new item, do as follows:

    getNavigationCase().add(newItem);
 

Objects of the following type(s) are allowed in the list FacesNavigationCase

getNavigationRuleExtension

public List<FacesNavigationRuleExtension> getNavigationRuleExtension()

Gets the value of the navigationRuleExtension property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the navigationRuleExtension property.

For example, to add a new item, do as follows:

    getNavigationRuleExtension().add(newItem);
 

Objects of the following type(s) are allowed in the list FacesNavigationRuleExtension

getId

public String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

public void setId(String value)

Sets the value of the id property.

Parameters:

value - allowed object is String