2009/05/20 - Apache Shale has been retired.

For more information, please explore the Attic.


1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to you under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.shale.view;
19  
20  /***
21   * <p>{@link ViewControllerMapper} is an interface describing a pluggable
22   * mechanism to map between a JavaServer Faces <em>view identifier</em>
23   * and the name of a corresponding <em>managed bean</em> that serves as
24   * the backing bean for this view.  If the managed bean class implements
25   * {@link ViewController}, the services described in that interface will
26   * be provided by Shale.</p>
27   *
28   * $Id: ViewControllerMapper.java 464373 2006-10-16 04:21:54Z rahul $
29   */
30  
31  public interface ViewControllerMapper {
32  
33      /***
34       * <p>Return the name of the managed bean that serves as the backing
35       * bean for the specified <code>view identifier</code>.  If no such
36       * managed bean name can be determined, return <code>null</code>.</p>
37       *
38       * @param viewId View identifier for which to identify a backing bean
39       */
40      public String mapViewId(String viewId);
41  
42  
43  }