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 javax.faces.application;
20
21 import java.util.Map;
22 import java.util.Set;
23
24 import javax.faces.context.FacesContext;
25 import javax.faces.flow.Flow;
26
27 /**
28 * @since 2.0
29 */
30 public abstract class ConfigurableNavigationHandler extends NavigationHandler
31 {
32
33 /**
34 *
35 */
36 public ConfigurableNavigationHandler()
37 {
38 }
39
40 public abstract NavigationCase getNavigationCase(FacesContext context, String fromAction, String outcome);
41
42 public abstract Map<String,Set<NavigationCase>> getNavigationCases();
43
44 public void performNavigation(String outcome)
45 {
46 handleNavigation(FacesContext.getCurrentInstance(), null, outcome);
47 }
48
49 /**
50 * @since 2.2
51 * @param context
52 * @param flow
53 */
54 public void inspectFlow(FacesContext context, Flow flow)
55 {
56 }
57
58 /**
59 * @since 2.2
60 * @param context
61 * @param fromAction
62 * @param outcome
63 * @param toFlowDocumentId
64 * @return
65 */
66 public NavigationCase getNavigationCase(FacesContext context,
67 java.lang.String fromAction,
68 java.lang.String outcome,
69 java.lang.String toFlowDocumentId)
70 {
71 return getNavigationCase(context, fromAction, outcome);
72 }
73 }