FacesNavigationRule

java.lang.Object
- org.apache.openejb.jee.FacesNavigationRule

public class FacesNavigationRule
extends java.lang.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 java.lang.String`	`fromViewId`
`protected LocalCollection<Icon>`	`icon`
`protected java.lang.String`	`id`
`protected java.util.List<FacesNavigationCase>`	`navigationCase`
`protected java.util.List<FacesNavigationRuleExtension>`	`navigationRuleExtension`

Constructor Summary

Constructors
Constructor and Description

FacesNavigationRule()

Constructors
Constructor and Description
`FacesNavigationRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDescription()`
`Text[]`	`getDescriptions()`
`java.lang.String`	`getDisplayName()`
`Text[]`	`getDisplayNames()`
`java.lang.String`	`getFromViewId()` Gets the value of the fromViewId property.
`Icon`	`getIcon()`
`java.util.Map<java.lang.String,Icon>`	`getIconMap()`
`java.util.Collection<Icon>`	`getIcons()`
`java.lang.String`	`getId()` Gets the value of the id property.
`java.util.List<FacesNavigationCase>`	`getNavigationCase()` Gets the value of the navigationCase property.
`java.util.List<FacesNavigationRuleExtension>`	`getNavigationRuleExtension()` Gets the value of the navigationRuleExtension property.
`void`	`setDescriptions(Text[] text)`
`void`	`setDisplayNames(Text[] text)`
`void`	`setFromViewId(java.lang.String value)` Sets the value of the fromViewId property.
`void`	`setId(java.lang.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 java.lang.String fromViewId
```
  - navigationCase
```
protected java.util.List<FacesNavigationCase> navigationCase
```
  - navigationRuleExtension
```
protected java.util.List<FacesNavigationRuleExtension> navigationRuleExtension
```
  - id
```
protected java.lang.String id
```
- Constructor Detail
  - FacesNavigationRule
```
public FacesNavigationRule()
```
- Method Detail
  - getDescriptions
```
public Text[] getDescriptions()
```
  - setDescriptions
```
public void setDescriptions(Text[] text)
```
  - getDescription
```
public java.lang.String getDescription()
```
  - getDisplayNames
```
public Text[] getDisplayNames()
```
  - setDisplayNames
```
public void setDisplayNames(Text[] text)
```
  - getDisplayName
```
public java.lang.String getDisplayName()
```
  - getIcons
```
public java.util.Collection<Icon> getIcons()
```
  - getIconMap
```
public java.util.Map<java.lang.String,Icon> getIconMap()
```
  - getIcon
```
public Icon getIcon()
```
  - getFromViewId
```
public java.lang.String getFromViewId()
```
    Gets the value of the fromViewId property.
    
    Returns:
    
    possible object is String
  - setFromViewId
```
public void setFromViewId(java.lang.String value)
```
    Sets the value of the fromViewId property.
    
    Parameters:
    
    value - allowed object is String
  - getNavigationCase
```
public java.util.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 java.util.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 java.lang.String getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is String
  - setId
```
public void setId(java.lang.String value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is String

Class FacesNavigationRule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

description

displayName

icon

fromViewId

navigationCase

navigationRuleExtension

id

Constructor Detail

FacesNavigationRule

Method Detail

getDescriptions

setDescriptions

getDescription

getDisplayNames

setDisplayNames

getDisplayName

getIcons

getIconMap

getIcon

getFromViewId

setFromViewId

getNavigationCase

getNavigationRuleExtension

getId

setId