org.apache.openejb.jee
Class FacesNavigationRule

java.lang.Object
  extended by org.apache.openejb.jee.FacesNavigationRule

public class FacesNavigationRule
extends java.lang.Object

The "navigation-rule" element represents an individual decision rule that will be utilized by the default NavigationHandler implementation to make decisions on what view should be displayed next, based on the view id being processed.

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
protected  java.util.List<DescriptionType> description
           
protected  java.util.List<java.lang.String> displayName
           
protected  java.lang.String fromViewId
           
protected  java.util.List<Icon> icon
           
protected  java.lang.String id
           
protected  java.util.List<FacesNavigationCase> navigationCase
           
protected  java.util.List<FacesNavigationRuleExtension> navigationRuleExtension
           
 
Constructor Summary
FacesNavigationRule()
           
 
Method Summary
 java.util.List<DescriptionType> getDescription()
          Gets the value of the description property.
 java.util.List<java.lang.String> getDisplayName()
          Gets the value of the displayName property.
 java.lang.String getFromViewId()
          Gets the value of the fromViewId property.
 java.util.List<Icon> getIcon()
          Gets the value of the icon property.
 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 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 java.util.List<DescriptionType> description

displayName

protected java.util.List<java.lang.String> displayName

icon

protected java.util.List<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

getDescription

public java.util.List<DescriptionType> getDescription()
Gets the value of the description 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 description property.

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

    getDescription().add(newItem);
 

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


getDisplayName

public java.util.List<java.lang.String> getDisplayName()
Gets the value of the displayName 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 displayName property.

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

    getDisplayName().add(newItem);
 

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


getIcon

public java.util.List<Icon> getIcon()
Gets the value of the icon 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 icon property.

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

    getIcon().add(newItem);
 

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


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


Copyright © 1999-2011 The Apache OpenEJB development community. All Rights Reserved.