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.trinidad.bean;
20  
21  import java.util.Map;
22  import javax.faces.context.FacesContext;
23  
24  
25  // TODO Make "stateHolder" a generic property of all PropertyMaps?
26  //     If so, tweak StateUtils accordingly
27  public interface PropertyMap extends Map<PropertyKey,Object>
28  {
29    public void markInitialState();
30    
31    /** 
32     * @return true if delta state changes are being tracked, otherwise false
33     */
34    public boolean initialStateMarked();
35  
36    /** 
37     * Reset to a non-delta tracking state.
38     */
39    public void clearInitialState();     
40    public Object saveState(FacesContext context);
41    public void restoreState(FacesContext context, FacesBean.Type type, Object state);
42  }