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 org.apache.myfaces.application;
20
21 import javax.faces.application.NavigationCase;
22 import javax.faces.application.NavigationCaseWrapper;
23
24 /**
25 * Wrapper that helps overriding toFlowDocumentId and fromOutcome, to build
26 * correctly a navigation case that cause a flow action (enter into a flow
27 * or return from a flow).
28 *
29 * The idea is if is necessary to enter into a flow set fromOutcome as the
30 * flow id and toFlowDocumentId as the flow document id. If it is a return,
31 * set fromOutcome as the return node and toFlowDocumentId as FlowHandler.NULL_FLOW
32 *
33 * @author Leonardo Uribe
34 */
35 public class FlowNavigationCase extends NavigationCaseWrapper
36 {
37
38 private NavigationCase _delegate;
39 private String _fromOutcome;
40 private String _toFlowDocumentId;
41
42 public FlowNavigationCase(NavigationCase delegate, String fromOutcome, String toFlowDocumentId)
43 {
44 this._delegate = delegate;
45 this._fromOutcome = fromOutcome;
46 this._toFlowDocumentId = toFlowDocumentId;
47 }
48
49 @Override
50 public NavigationCase getWrapped()
51 {
52 return _delegate;
53 }
54
55 @Override
56 public String getFromOutcome()
57 {
58 return _fromOutcome;
59 }
60
61 @Override
62 public String getToFlowDocumentId()
63 {
64 return _toFlowDocumentId;
65 }
66 }