01: /*
02: * Copyright 2004-2007 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.springframework.webflow.executor.jsf;
17:
18: import javax.faces.application.ViewHandler;
19:
20: /**
21: * Interface to be implemented by objects that can map Web Flow view names to JSF view identifiers. JSF view identifiers
22: * are used to determine if the current view has changed and to create views by delegating to the application's
23: * {@link ViewHandler}.
24: *
25: * A view handler typically treats a JSF view id as the physical location of a view template encapsulating a page
26: * layout. The JSF view id normally specifies the physical location of the view template minus a suffix. View handlers
27: * typically replace the suffix of any view id with their own default suffix (e.g. ".jsp" or ".xhtml") and then try to
28: * locate a physical template view.
29: *
30: * @author Colin Sampaleanu
31: */
32: public interface ViewIdMapper {
33:
34: /**
35: * Map the given Spring Web Flow view name to a JSF view identifier.
36: * @param viewName name of the view to map
37: * @return the corresponding JSF view id
38: */
39: public String mapViewId(String viewName);
40:
41: }
|