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.view.facelets.pool;
20  
21  import org.apache.myfaces.context.RequestViewMetadata;
22  
23  /**
24   * Contains additional information associated to a view and restored each time
25   * the view is built by first time.
26   *
27   */
28  public abstract class ViewStructureMetadata
29  {
30      /**
31       * Retrieve the state of UIViewRoot after the view is built by first time.
32       * 
33       * @return the viewState
34       */
35      public abstract Object getViewRootState();
36      
37      /**
38       * Retrieve the associated RequestViewMetadata to this view structure.
39       * 
40       * @return 
41       */
42      public abstract RequestViewMetadata getRequestViewMetadata();
43      
44  }