001    // Copyright 2004, 2005 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry.contrib.table.model;
016    
017    import java.io.Serializable;
018    
019    /**
020     * An interface responsible for determining <b>what</b> data would be stored in
021     * the session between requests. It could be only the table state, it could be
022     * entire table including the data, or it could be nothing at all. It is all
023     * determined by the implemention of this interface.
024     * 
025     * @author mindbridge
026     */
027    public interface ITableSessionStateManager
028    {
029    
030        /**
031         * Method getSessionState extracts the "persistent" portion of the table
032         * model.
033         * 
034         * @param objModel
035         *            the table model to extract the session state from
036         * @return Object the session state to be saved between the requests
037         */
038        Serializable getSessionState(ITableModel objModel);
039    
040        /**
041         * Method recreateTableModel recreates a table model from the saved session
042         * state.
043         * 
044         * @param objState
045         *            the saved session state
046         * @return ITableModel the recreated table model
047         */
048        ITableModel recreateTableModel(Serializable objState);
049    }