Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ITableSessionStateManager |
|
| 1.0;1 |
1 | // Copyright 2004, 2005 The Apache Software Foundation | |
2 | // | |
3 | // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 | // you may not use this file except in compliance with the License. | |
5 | // You may obtain a copy of the License at | |
6 | // | |
7 | // http://www.apache.org/licenses/LICENSE-2.0 | |
8 | // | |
9 | // Unless required by applicable law or agreed to in writing, software | |
10 | // distributed under the License is distributed on an "AS IS" BASIS, | |
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 | // See the License for the specific language governing permissions and | |
13 | // limitations under the License. | |
14 | ||
15 | package org.apache.tapestry.contrib.table.model; | |
16 | ||
17 | import java.io.Serializable; | |
18 | ||
19 | /** | |
20 | * An interface responsible for determining <b>what</b> data would be stored in | |
21 | * the session between requests. It could be only the table state, it could be | |
22 | * entire table including the data, or it could be nothing at all. It is all | |
23 | * determined by the implemention of this interface. | |
24 | * | |
25 | * @author mindbridge | |
26 | */ | |
27 | public interface ITableSessionStateManager | |
28 | { | |
29 | ||
30 | /** | |
31 | * Method getSessionState extracts the "persistent" portion of the table | |
32 | * model. | |
33 | * | |
34 | * @param objModel | |
35 | * the table model to extract the session state from | |
36 | * @return Object the session state to be saved between the requests | |
37 | */ | |
38 | Serializable getSessionState(ITableModel objModel); | |
39 | ||
40 | /** | |
41 | * Method recreateTableModel recreates a table model from the saved session | |
42 | * state. | |
43 | * | |
44 | * @param objState | |
45 | * the saved session state | |
46 | * @return ITableModel the recreated table model | |
47 | */ | |
48 | ITableModel recreateTableModel(Serializable objState); | |
49 | } |