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 javax.faces.component.UIViewRoot;
22  
23  /**
24   *
25   * @author Leonardo Uribe
26   */
27  public abstract class ViewEntry
28  {
29      /**
30       * @return the viewRoot
31       */
32      public abstract UIViewRoot getViewRoot();
33  
34      /**
35       * Execute all necessary steps to ensure further calls to 
36       * getViewRoot() and getViewState() will return valid values.
37       * It returns true or false if the Entry is still active or not
38       * 
39       */
40      public abstract boolean activate();
41      
42      /**
43       * @return the result
44       */
45      public abstract RestoreViewFromPoolResult getResult();
46  
47      /**
48       * @param result the result to set
49       */
50      public abstract void setResult(RestoreViewFromPoolResult result);
51  
52  }