01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/portal/tags/sakai_2-4-1/portal-api/api/src/java/org/sakaiproject/portal/api/StoredState.java $
03: * $Id: StoredState.java 29143 2007-04-19 01:10:38Z ajpoland@iupui.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.portal.api;
21:
22: import javax.servlet.http.HttpServletRequest;
23:
24: import org.sakaiproject.tool.api.Placement;
25:
26: /**
27: * Stored state is used to store the request state over a number of requests, It
28: * is used to restore state over a login sequence of during a direct placement
29: * into a tool state.
30: *
31: * @author ieb
32: * @since Sakai 2.4
33: * @version $Rev: 29143 $
34: *
35: */
36: public interface StoredState {
37:
38: /**
39: * Get the Tool Context Path that the state was stored against
40: * @return
41: */
42: String getToolContextPath();
43:
44: /**
45: * Get the request of the stored state
46: * @param req
47: * @return
48: */
49: HttpServletRequest getRequest(HttpServletRequest req);
50:
51: /**
52: * Get the placement of the stored state
53: * @return
54: */
55: Placement getPlacement();
56:
57: /**
58: * Get the Path info to the target tool
59: * @return
60: */
61: String getToolPathInfo();
62:
63: /**
64: * Get the skin associated with the stored state
65: * @return
66: */
67: String getSkin();
68:
69: /**
70: * Set the request in the stored state
71: * @param req
72: */
73: void setRequest(HttpServletRequest req);
74:
75: /**
76: * set the placement
77: * @param siteTool
78: */
79: void setPlacement(Placement siteTool);
80:
81: /**
82: * set the tool context
83: * @param toolContextPath
84: */
85: void setToolContextPath(String toolContextPath);
86:
87: /**
88: * set the tool path info
89: * @param toolPathInfo
90: */
91: void setToolPathInfo(String toolPathInfo);
92:
93: /**
94: * set the skin
95: * @param skin
96: */
97: void setSkin(String skin);
98:
99: }
|