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.renderkit;
20  
21  import javax.faces.application.StateManager;
22  import javax.faces.context.FacesContext;
23  import javax.faces.render.ResponseStateManager;
24  import java.io.IOException;
25  
26  /**
27   * @author Manfred Geiler (latest modification by $Author: grantsmith $)
28   * @version $Revision: 472618 $ $Date: 2006-11-08 15:06:54 -0500 (Wed, 08 Nov 2006) $
29   */
30  public abstract class MyfacesResponseStateManager
31          extends ResponseStateManager
32  {
33      /**
34       * Writes hidden form inputs with the state info to be saved.
35       * {@link StateManager} delegates calls to {@link javax.faces.application.StateManager#writeState}
36       * to this method.
37       */
38      public abstract void writeState(FacesContext facescontext,
39                                      StateManager.SerializedView serializedview) throws IOException;
40  
41      /**
42       * Writes url parameters with the state info to be saved.
43       * {@link org.apache.myfaces.application.MyfacesStateManager} delegates calls to
44       * {@link org.apache.myfaces.application.MyfacesStateManager#writeState} to this method.
45       */
46      public abstract void writeStateAsUrlParams(FacesContext facescontext,
47                                                 StateManager.SerializedView serializedview) throws IOException;
48  }