FacesConfigFlowDefinition

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

public class FacesConfigFlowDefinition
extends java.lang.Object

Top level element for a flow definition.

If there is no <start-node> element declared, it is assumed to be <flowName>.xhtml.

Java class for faces-config-flow-definitionType complex type.

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

 <complexType name="faces-config-flow-definitionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://xmlns.jcp.org/xml/ns/javaee}descriptionGroup"/>
         <element name="start-node" type="{http://xmlns.jcp.org/xml/ns/javaee}java-identifierType" minOccurs="0"/>
         <element name="view" type="{http://xmlns.jcp.org/xml/ns/javaee}faces-config-flow-definition-viewType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="switch" type="{http://xmlns.jcp.org/xml/ns/javaee}faces-config-flow-definition-switchType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="flow-return" type="{http://xmlns.jcp.org/xml/ns/javaee}faces-config-flow-definition-flow-returnType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="navigation-rule" type="{http://xmlns.jcp.org/xml/ns/javaee}faces-config-navigation-ruleType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="flow-call" type="{http://xmlns.jcp.org/xml/ns/javaee}faces-config-flow-definition-flow-callType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="method-call" type="{http://xmlns.jcp.org/xml/ns/javaee}faces-config-flow-definition-faces-method-callType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="initializer" type="{http://xmlns.jcp.org/xml/ns/javaee}faces-config-flow-definition-initializerType" minOccurs="0"/>
         <element name="finalizer" type="{http://xmlns.jcp.org/xml/ns/javaee}faces-config-flow-definition-finalizerType" minOccurs="0"/>
         <element name="inbound-parameter" type="{http://xmlns.jcp.org/xml/ns/javaee}faces-config-flow-definition-inbound-parameterType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="id" use="required" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<FacesConfigFlowDefinitionSwitch>`	`_switch`
`protected java.util.List<Description>`	`description`
`protected java.util.List<DisplayName>`	`displayName`
`protected FacesConfigFlowDefinitionFinalizer`	`finalizer`
`protected java.util.List<FacesConfigFlowDefinitionFlowCall>`	`flowCall`
`protected java.util.List<FacesConfigFlowDefinitionFlowReturn>`	`flowReturn`
`protected java.util.List<Icon>`	`icon`
`protected java.lang.String`	`id`
`protected java.util.List<FacesConfigFlowDefinitionInboundParameter>`	`inboundParameter`
`protected FacesConfigFlowDefinitionInitializer`	`initializer`
`protected java.util.List<FacesConfigFlowDefinitionFacesMethodCall>`	`methodCall`
`protected java.util.List<FacesNavigationRule>`	`navigationRule`
`protected JavaIdentifier`	`startNode`
`protected java.util.List<FacesConfigFlowDefinitionView>`	`view`

Constructor Summary

Constructors
Constructor and Description

FacesConfigFlowDefinition()

Constructors
Constructor and Description
`FacesConfigFlowDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<Description>`	`getDescription()` Gets the value of the description property.
`java.util.List<DisplayName>`	`getDisplayName()` Gets the value of the displayName property.
`FacesConfigFlowDefinitionFinalizer`	`getFinalizer()` Gets the value of the finalizer property.
`java.util.List<FacesConfigFlowDefinitionFlowCall>`	`getFlowCall()` Gets the value of the flowCall property.
`java.util.List<FacesConfigFlowDefinitionFlowReturn>`	`getFlowReturn()` Gets the value of the flowReturn 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<FacesConfigFlowDefinitionInboundParameter>`	`getInboundParameter()` Gets the value of the inboundParameter property.
`FacesConfigFlowDefinitionInitializer`	`getInitializer()` Gets the value of the initializer property.
`java.util.List<FacesConfigFlowDefinitionFacesMethodCall>`	`getMethodCall()` Gets the value of the methodCall property.
`java.util.List<FacesNavigationRule>`	`getNavigationRule()` Gets the value of the navigationRule property.
`JavaIdentifier`	`getStartNode()` Gets the value of the startNode property.
`java.util.List<FacesConfigFlowDefinitionSwitch>`	`getSwitch()` Gets the value of the switch property.
`java.util.List<FacesConfigFlowDefinitionView>`	`getView()` Gets the value of the view property.
`void`	`setFinalizer(FacesConfigFlowDefinitionFinalizer value)` Sets the value of the finalizer property.
`void`	`setId(java.lang.String value)` Sets the value of the id property.
`void`	`setInitializer(FacesConfigFlowDefinitionInitializer value)` Sets the value of the initializer property.
`void`	`setStartNode(JavaIdentifier value)` Sets the value of the startNode 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<Description> description
```
  - displayName
```
protected java.util.List<DisplayName> displayName
```
  - icon
```
protected java.util.List<Icon> icon
```
  - startNode
```
protected JavaIdentifier startNode
```
  - view
```
protected java.util.List<FacesConfigFlowDefinitionView> view
```
  - _switch
```
protected java.util.List<FacesConfigFlowDefinitionSwitch> _switch
```
  - flowReturn
```
protected java.util.List<FacesConfigFlowDefinitionFlowReturn> flowReturn
```
  - navigationRule
```
protected java.util.List<FacesNavigationRule> navigationRule
```
  - flowCall
```
protected java.util.List<FacesConfigFlowDefinitionFlowCall> flowCall
```
  - methodCall
```
protected java.util.List<FacesConfigFlowDefinitionFacesMethodCall> methodCall
```
  - initializer
```
protected FacesConfigFlowDefinitionInitializer initializer
```
  - finalizer
```
protected FacesConfigFlowDefinitionFinalizer finalizer
```
  - inboundParameter
```
protected java.util.List<FacesConfigFlowDefinitionInboundParameter> inboundParameter
```
  - id
```
protected java.lang.String id
```
- Constructor Detail
  - FacesConfigFlowDefinition
```
public FacesConfigFlowDefinition()
```
- Method Detail
  - getDescription
```
public java.util.List<Description> 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 Description
  - getDisplayName
```
public java.util.List<DisplayName> 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 DisplayName
  - 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
  - getStartNode
```
public JavaIdentifier getStartNode()
```
    Gets the value of the startNode property.
    
    Returns:
    
    possible object is JavaIdentifier
  - setStartNode
```
public void setStartNode(JavaIdentifier value)
```
    Sets the value of the startNode property.
    
    Parameters:
    
    value - allowed object is JavaIdentifier
  - getView
```
public java.util.List<FacesConfigFlowDefinitionView> getView()
```
    Gets the value of the view 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 view property.
    
    For example, to add a new item, do as follows:
```
    getView().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list FacesConfigFlowDefinitionView
  - getSwitch
```
public java.util.List<FacesConfigFlowDefinitionSwitch> getSwitch()
```
    Gets the value of the switch 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 switch property.
    
    For example, to add a new item, do as follows:
```
    getSwitch().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list FacesConfigFlowDefinitionSwitch
  - getFlowReturn
```
public java.util.List<FacesConfigFlowDefinitionFlowReturn> getFlowReturn()
```
    Gets the value of the flowReturn 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 flowReturn property.
    
    For example, to add a new item, do as follows:
```
    getFlowReturn().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list FacesConfigFlowDefinitionFlowReturn
  - getNavigationRule
```
public java.util.List<FacesNavigationRule> getNavigationRule()
```
    Gets the value of the navigationRule 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 navigationRule property.
    
    For example, to add a new item, do as follows:
```
    getNavigationRule().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list FacesConfigNavigationRule
  - getFlowCall
```
public java.util.List<FacesConfigFlowDefinitionFlowCall> getFlowCall()
```
    Gets the value of the flowCall 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 flowCall property.
    
    For example, to add a new item, do as follows:
```
    getFlowCall().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list FacesConfigFlowDefinitionFlowCall
  - getMethodCall
```
public java.util.List<FacesConfigFlowDefinitionFacesMethodCall> getMethodCall()
```
    Gets the value of the methodCall 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 methodCall property.
    
    For example, to add a new item, do as follows:
```
    getMethodCall().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list FacesConfigFlowDefinitionFacesMethodCall
  - getInitializer
```
public FacesConfigFlowDefinitionInitializer getInitializer()
```
    Gets the value of the initializer property.
    
    Returns:
    
    possible object is FacesConfigFlowDefinitionInitializer
  - setInitializer
```
public void setInitializer(FacesConfigFlowDefinitionInitializer value)
```
    Sets the value of the initializer property.
    
    Parameters:
    
    value - allowed object is FacesConfigFlowDefinitionInitializer
  - getFinalizer
```
public FacesConfigFlowDefinitionFinalizer getFinalizer()
```
    Gets the value of the finalizer property.
    
    Returns:
    
    possible object is FacesConfigFlowDefinitionFinalizer
  - setFinalizer
```
public void setFinalizer(FacesConfigFlowDefinitionFinalizer value)
```
    Sets the value of the finalizer property.
    
    Parameters:
    
    value - allowed object is FacesConfigFlowDefinitionFinalizer
  - getInboundParameter
```
public java.util.List<FacesConfigFlowDefinitionInboundParameter> getInboundParameter()
```
    Gets the value of the inboundParameter 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 inboundParameter property.
    
    For example, to add a new item, do as follows:
```
    getInboundParameter().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list FacesConfigFlowDefinitionInboundParameter
  - 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 FacesConfigFlowDefinition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

description

displayName

icon

startNode

view

_switch

flowReturn

navigationRule

flowCall

methodCall

initializer

finalizer

inboundParameter

id

Constructor Detail

FacesConfigFlowDefinition

Method Detail

getDescription

getDisplayName

getIcon

getStartNode

setStartNode

getView

getSwitch

getFlowReturn

getNavigationRule

getFlowCall

getMethodCall

getInitializer

setInitializer

getFinalizer

setFinalizer

getInboundParameter

getId

setId