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.context.FacesContext;
22  
23  /**
24   *
25   * @since 2.2
26   */
27  public abstract class FlowHandler
28  {
29      public static final String FLOW_ID_REQUEST_PARAM_NAME = "jffi";
30      public static final String NULL_FLOW = "jakarta.faces.flow.NullFlow";
31      public static final String TO_FLOW_DOCUMENT_ID_REQUEST_PARAM_NAME = "jftfdi";
32  
33      public abstract java.util.Map<java.lang.Object, java.lang.Object> getCurrentFlowScope();
34  
35      public abstract Flow getFlow(FacesContext context,
36          String definingDocumentId, String id);
37  
38      public abstract void addFlow(FacesContext context,
39          Flow toAdd);
40  
41      public abstract Flow getCurrentFlow(FacesContext context);
42  
43      public Flow getCurrentFlow()
44      {
45          return getCurrentFlow(FacesContext.getCurrentInstance());
46      }
47  
48      public abstract void transition(FacesContext context,
49          Flow sourceFlow, Flow targetFlow,
50          FlowCallNode outboundCallNode, String toViewId);
51  
52      public abstract boolean isActive(FacesContext context,
53          String definingDocument, String id);
54      
55      public abstract void clientWindowTransition(FacesContext context);
56      
57      public abstract String getLastDisplayedViewId(FacesContext context);
58      
59      public abstract void pushReturnMode(FacesContext context);
60      
61      public abstract void popReturnMode(FacesContext context);
62  }