View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package jakarta.faces.flow;
20  
21  import jakarta.faces.application.NavigationCase;
22  import jakarta.faces.lifecycle.ClientWindow;
23  
24  import java.util.List;
25  import java.util.Map;
26  
27  /**
28   *
29   * @since 2.2
30   */
31  public abstract class Flow
32  {
33      
34      public abstract String getClientWindowFlowId(ClientWindow curWindow);
35  
36      public abstract String getDefiningDocumentId();
37  
38      public abstract String getId();
39  
40      public abstract Map<String,Parameter> getInboundParameters();
41      
42      public abstract jakarta.el.MethodExpression getInitializer();
43      
44      public abstract jakarta.el.MethodExpression getFinalizer();
45      
46      public abstract FlowCallNode getFlowCall(Flow targetFlow);
47      
48      public abstract Map<String,FlowCallNode> getFlowCalls();
49      
50      public abstract List<MethodCallNode> getMethodCalls();
51      
52      public abstract FlowNode getNode(String nodeId);
53      
54      public abstract Map<String,ReturnNode> getReturns();
55      
56      public abstract Map<String,SwitchNode> getSwitches();
57      
58      public abstract List<ViewNode> getViews();
59      
60      public abstract String getStartNodeId();
61      
62      public abstract java.util.Map<java.lang.String,java.util.Set<NavigationCase>> getNavigationCases();
63      
64  }