Google Git
Sign in
apache / tomee-site-pub / 3134d93685ad37a3d6ba80a0a9d7c33769da34b2 / . / jakartaee-9.1 / javadoc / jakarta / faces / flow / Flow.html
blob: 736b7a2075fcc448bb75718666f92baf899fea20 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Flow</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<link rel="shortcut icon" href="/img/jakarta-favicon.ico">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Flow";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../jakarta/faces/flow/FlowCallNode.html" title="class in jakarta.faces.flow"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/faces/flow/Flow.html" target="_top">Frames</a></li>
<li><a href="Flow.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">jakarta.faces.flow</div>
<h2 title="Class Flow" class="title">Class Flow</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>jakarta.faces.flow.Flow</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Flow</span>
extends java.lang.Object</pre>
<div class="block"><p class="changed_added_2_2">
<strong>Flow</strong> is the runtime representation of a Faces Flow. Once placed into service by the runtime, an
instance of this class is immutable. The implementation must be thread-safe because instances will be shared across
all usages of the flow within the application.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#Flow--">Flow</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getClientWindowFlowId-jakarta.faces.lifecycle.ClientWindow-">getClientWindowFlowId</a></span>(<a href="../../../jakarta/faces/lifecycle/ClientWindow.html" title="class in jakarta.faces.lifecycle">ClientWindow</a>&nbsp;curWindow)</code>
<div class="block"><p class="changed_added_2_2">
Get the <a href="../../../jakarta/faces/lifecycle/ClientWindow.html" title="class in jakarta.faces.lifecycle"><code>ClientWindow</code></a>'s id and append "_" and the return from <a href="../../../jakarta/faces/flow/Flow.html#getId--"><code>getId()</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getDefiningDocumentId--">getDefiningDocumentId</a></span>()</code>
<div class="block"><p class="changed_added_2_2">
Return the immutable application unique identifier for the document in which the argument flow is defined.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../jakarta/el/MethodExpression.html" title="class in jakarta.el">MethodExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getFinalizer--">getFinalizer</a></span>()</code>
<div class="block"><p class="changed_added_2_2">
Return the <code>MethodExpression</code> that must be called by the runtime as the last thing that happens before exiting
this flow.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../jakarta/faces/flow/FlowCallNode.html" title="class in jakarta.faces.flow">FlowCallNode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getFlowCall-jakarta.faces.flow.Flow-">getFlowCall</a></span>(<a href="../../../jakarta/faces/flow/Flow.html" title="class in jakarta.faces.flow">Flow</a>&nbsp;targetFlow)</code>
<div class="block"><p class="changed_added_2_2">
Return the <a href="../../../jakarta/faces/flow/FlowCallNode.html" title="class in jakarta.faces.flow"><code>FlowCallNode</code></a> that represents calling the <code>targetFlow</code> from this flow, or <code>null</code> if
<code>targetFlow</code> cannot be reached from this flow.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract java.util.Map&lt;java.lang.String,<a href="../../../jakarta/faces/flow/FlowCallNode.html" title="class in jakarta.faces.flow">FlowCallNode</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getFlowCalls--">getFlowCalls</a></span>()</code>
<div class="block"><p class="changed_added_2_2">
Return an immutable data structure containing all the flow call nodes declared for this flow.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getId--">getId</a></span>()</code>
<div class="block"><p class="changed_added_2_2">
Return the immutable id for this Flow.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract java.util.Map&lt;java.lang.String,<a href="../../../jakarta/faces/flow/Parameter.html" title="class in jakarta.faces.flow">Parameter</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getInboundParameters--">getInboundParameters</a></span>()</code>
<div class="block"><p class="changed_added_2_2">
Return an immutable data structure containing the inbound parameters that have been declared for this flow.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../jakarta/el/MethodExpression.html" title="class in jakarta.el">MethodExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getInitializer--">getInitializer</a></span>()</code>
<div class="block"><p class="changed_added_2_2">
Return the <code>MethodExpression</code> that must be called by the runtime immediately after activating any
<a href="../../../jakarta/faces/flow/FlowScoped.html" title="annotation in jakarta.faces.flow"><code>FlowScoped</code></a> beans declared for this flow.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>abstract java.util.List&lt;<a href="../../../jakarta/faces/flow/MethodCallNode.html" title="class in jakarta.faces.flow">MethodCallNode</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getMethodCalls--">getMethodCalls</a></span>()</code>
<div class="block"><p class="changed_added_2_2">
Return an immutable data structure containing all the method call nodes declared for this flow.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>abstract java.util.Map&lt;java.lang.String,java.util.Set&lt;<a href="../../../jakarta/faces/application/NavigationCase.html" title="class in jakarta.faces.application">NavigationCase</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getNavigationCases--">getNavigationCases</a></span>()</code>
<div class="block"><p class="changed_added_2_2">
Return an unmodifiable view of the navigation cases within this flow.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../jakarta/faces/flow/FlowNode.html" title="class in jakarta.faces.flow">FlowNode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getNode-java.lang.String-">getNode</a></span>(java.lang.String&nbsp;nodeId)</code>
<div class="block"><p class="changed_added_2_2">
Return the generic <a href="../../../jakarta/faces/flow/FlowNode.html" title="class in jakarta.faces.flow"><code>FlowNode</code></a> by id, or <code>null</code> if not found.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>abstract java.util.Map&lt;java.lang.String,<a href="../../../jakarta/faces/flow/ReturnNode.html" title="class in jakarta.faces.flow">ReturnNode</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getReturns--">getReturns</a></span>()</code>
<div class="block"><p class="changed_added_2_2">
Return an immutable data structure containing all of the return nodes declared for this flow.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getStartNodeId--">getStartNodeId</a></span>()</code>
<div class="block"><p class="changed_added_2_2">
Return the immutable id for the default node that should be activated when this flow is entered.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>abstract java.util.Map&lt;java.lang.String,<a href="../../../jakarta/faces/flow/SwitchNode.html" title="class in jakarta.faces.flow">SwitchNode</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getSwitches--">getSwitches</a></span>()</code>
<div class="block"><p class="changed_added_2_2">
Return an immutable data structure containing all of the switch nodes declared for this flow.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>abstract java.util.List&lt;<a href="../../../jakarta/faces/flow/ViewNode.html" title="class in jakarta.faces.flow">ViewNode</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/faces/flow/Flow.html#getViews--">getViews</a></span>()</code>
<div class="block"><p class="changed_added_2_2">
Return an immutable data structure containing all of the view nodes declared for this flow.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Flow--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Flow</h4>
<pre>public&nbsp;Flow()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;getId()</pre>
<div class="block"><p class="changed_added_2_2">
Return the immutable id for this Flow. This must be unique within the defining document (such as an Application
Configuration Resources file), but need not be unique within the entire application.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the id.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getDefiningDocumentId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefiningDocumentId</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;getDefiningDocumentId()</pre>
<div class="block"><p class="changed_added_2_2">
Return the immutable application unique identifier for the document in which the argument flow is defined.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the defining document id</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getStartNodeId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartNodeId</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;getStartNodeId()</pre>
<div class="block"><p class="changed_added_2_2">
Return the immutable id for the default node that should be activated when this flow is entered.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the id of the start node</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getFinalizer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFinalizer</h4>
<pre>public abstract&nbsp;<a href="../../../jakarta/el/MethodExpression.html" title="class in jakarta.el">MethodExpression</a>&nbsp;getFinalizer()</pre>
<div class="block"><p class="changed_added_2_2">
Return the <code>MethodExpression</code> that must be called by the runtime as the last thing that happens before exiting
this flow. Any <a href="../../../jakarta/faces/flow/FlowScoped.html" title="annotation in jakarta.faces.flow"><code>FlowScoped</code></a> beans declared for this flow must remain in scope until after control returns from
the method referenced by this <code>MethodExpression</code>.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>MethodExpresion</code> for the finalizer.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getInitializer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitializer</h4>
<pre>public abstract&nbsp;<a href="../../../jakarta/el/MethodExpression.html" title="class in jakarta.el">MethodExpression</a>&nbsp;getInitializer()</pre>
<div class="block"><p class="changed_added_2_2">
Return the <code>MethodExpression</code> that must be called by the runtime immediately after activating any
<a href="../../../jakarta/faces/flow/FlowScoped.html" title="annotation in jakarta.faces.flow"><code>FlowScoped</code></a> beans declared for this flow.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>MethodExpresion</code> for the initializer.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getInboundParameters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInboundParameters</h4>
<pre>public abstract&nbsp;java.util.Map&lt;java.lang.String,<a href="../../../jakarta/faces/flow/Parameter.html" title="class in jakarta.faces.flow">Parameter</a>&gt;&nbsp;getInboundParameters()</pre>
<div class="block"><p class="changed_added_2_2">
Return an immutable data structure containing the inbound parameters that have been declared for this flow. See
<a href="../../../jakarta/faces/flow/FlowHandler.html#transition-jakarta.faces.context.FacesContext-jakarta.faces.flow.Flow-jakarta.faces.flow.Flow-jakarta.faces.flow.FlowCallNode-java.lang.String-"><code>FlowHandler.transition(jakarta.faces.context.FacesContext, jakarta.faces.flow.Flow, jakarta.faces.flow.Flow, jakarta.faces.flow.FlowCallNode, java.lang.String)</code></a> for the specification of how these parameters are used. Inbound parameters are
associated with a specific flow instance, while outbound parameters are associated with a <a href="../../../jakarta/faces/flow/FlowCallNode.html" title="class in jakarta.faces.flow"><code>FlowCallNode</code></a> that
causes the transition to a new flow.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the inbound parameters</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getViews--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getViews</h4>
<pre>public abstract&nbsp;java.util.List&lt;<a href="../../../jakarta/faces/flow/ViewNode.html" title="class in jakarta.faces.flow">ViewNode</a>&gt;&nbsp;getViews()</pre>
<div class="block"><p class="changed_added_2_2">
Return an immutable data structure containing all of the view nodes declared for this flow.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the view nodes for this flow</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getReturns--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReturns</h4>
<pre>public abstract&nbsp;java.util.Map&lt;java.lang.String,<a href="../../../jakarta/faces/flow/ReturnNode.html" title="class in jakarta.faces.flow">ReturnNode</a>&gt;&nbsp;getReturns()</pre>
<div class="block"><p class="changed_added_2_2">
Return an immutable data structure containing all of the return nodes declared for this flow.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the return nodes for this flow.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getSwitches--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSwitches</h4>
<pre>public abstract&nbsp;java.util.Map&lt;java.lang.String,<a href="../../../jakarta/faces/flow/SwitchNode.html" title="class in jakarta.faces.flow">SwitchNode</a>&gt;&nbsp;getSwitches()</pre>
<div class="block"><p class="changed_added_2_2">
Return an immutable data structure containing all of the switch nodes declared for this flow.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the switch nodes for this flow</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getFlowCalls--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlowCalls</h4>
<pre>public abstract&nbsp;java.util.Map&lt;java.lang.String,<a href="../../../jakarta/faces/flow/FlowCallNode.html" title="class in jakarta.faces.flow">FlowCallNode</a>&gt;&nbsp;getFlowCalls()</pre>
<div class="block"><p class="changed_added_2_2">
Return an immutable data structure containing all the flow call nodes declared for this flow.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the flow call nodes for this flow</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getFlowCall-jakarta.faces.flow.Flow-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlowCall</h4>
<pre>public abstract&nbsp;<a href="../../../jakarta/faces/flow/FlowCallNode.html" title="class in jakarta.faces.flow">FlowCallNode</a>&nbsp;getFlowCall(<a href="../../../jakarta/faces/flow/Flow.html" title="class in jakarta.faces.flow">Flow</a>&nbsp;targetFlow)</pre>
<div class="block"><p class="changed_added_2_2">
Return the <a href="../../../jakarta/faces/flow/FlowCallNode.html" title="class in jakarta.faces.flow"><code>FlowCallNode</code></a> that represents calling the <code>targetFlow</code> from this flow, or <code>null</code> if
<code>targetFlow</code> cannot be reached from this flow.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targetFlow</code> - the flow for which the <a href="../../../jakarta/faces/flow/FlowCallNode.html" title="class in jakarta.faces.flow"><code>FlowCallNode</code></a> is to be returned</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../jakarta/faces/flow/FlowCallNode.html" title="class in jakarta.faces.flow"><code>FlowCallNode</code></a> for the argument flow or <code>null</code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getMethodCalls--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMethodCalls</h4>
<pre>public abstract&nbsp;java.util.List&lt;<a href="../../../jakarta/faces/flow/MethodCallNode.html" title="class in jakarta.faces.flow">MethodCallNode</a>&gt;&nbsp;getMethodCalls()</pre>
<div class="block"><p class="changed_added_2_2">
Return an immutable data structure containing all the method call nodes declared for this flow.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the method call nodes for this flow</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
<a name="getNode-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNode</h4>
<pre>public abstract&nbsp;<a href="../../../jakarta/faces/flow/FlowNode.html" title="class in jakarta.faces.flow">FlowNode</a>&nbsp;getNode(java.lang.String&nbsp;nodeId)</pre>
<div class="block"><p class="changed_added_2_2">
Return the generic <a href="../../../jakarta/faces/flow/FlowNode.html" title="class in jakarta.faces.flow"><code>FlowNode</code></a> by id, or <code>null</code> if not found.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeId</code> - the node id for which the <a href="../../../jakarta/faces/flow/FlowNode.html" title="class in jakarta.faces.flow"><code>FlowNode</code></a> is to be returned</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../jakarta/faces/flow/FlowNode.html" title="class in jakarta.faces.flow"><code>FlowNode</code></a> or <code>null</code></dd>
</dl>
</li>
</ul>
<a name="getNavigationCases--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNavigationCases</h4>
<pre>public abstract&nbsp;java.util.Map&lt;java.lang.String,java.util.Set&lt;<a href="../../../jakarta/faces/application/NavigationCase.html" title="class in jakarta.faces.application">NavigationCase</a>&gt;&gt;&nbsp;getNavigationCases()</pre>
<div class="block"><p class="changed_added_2_2">
Return an unmodifiable view of the navigation cases within this flow.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the navigation cases,</dd>
</dl>
</li>
</ul>
<a name="getClientWindowFlowId-jakarta.faces.lifecycle.ClientWindow-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getClientWindowFlowId</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;getClientWindowFlowId(<a href="../../../jakarta/faces/lifecycle/ClientWindow.html" title="class in jakarta.faces.lifecycle">ClientWindow</a>&nbsp;curWindow)</pre>
<div class="block"><p class="changed_added_2_2">
Get the <a href="../../../jakarta/faces/lifecycle/ClientWindow.html" title="class in jakarta.faces.lifecycle"><code>ClientWindow</code></a>'s id and append "_" and the return from <a href="../../../jakarta/faces/flow/Flow.html#getId--"><code>getId()</code></a>. Return the result.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>curWindow</code> - the</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the generated client window id for this flow.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.2</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../jakarta/faces/flow/FlowCallNode.html" title="class in jakarta.faces.flow"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/faces/flow/Flow.html" target="_top">Frames</a></li>
<li><a href="Flow.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>