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 org.apache.myfaces.config.element;
20  
21  import java.io.Serializable;
22  import java.util.Collection;
23  
24  /**
25   * Entry of the Collection returned by
26   * {@link org.apache.myfaces.config.RuntimeConfig#getNavigationRules()}.
27   *
28   * @author Manfred Geiler (latest modification by $Author: bommel $)
29   * @version $Revision: 1187700 $ $Date: 2011-10-22 07:19:37 -0500 (Sat, 22 Oct 2011) $
30   */
31  public abstract class NavigationRule implements Serializable
32  {
33      // <!ELEMENT navigation-rule (description*, display-name*, icon*, from-view-id?, navigation-case*)>
34  
35      public abstract String getFromViewId();
36  
37      /**
38       * @return a Collection of {@link org.apache.myfaces.config.element.NavigationCase}s
39       */
40      public abstract Collection<? extends NavigationCase> getNavigationCases();
41  }