org.sakaiproject.portal.api

Interface StoredState

public interface StoredState

Stored state is used to store the request state over a number of requests, It is used to restore state over a login sequence of during a direct placement into a tool state.

Since:

Sakai 2.4

Version:

$Rev$

Author:

ieb

Method Summary

Modifier and Type	Method and Description
Placement	getPlacement() Get the placement of the stored state
javax.servlet.http.HttpServletRequest	getRequest(javax.servlet.http.HttpServletRequest req) Get the request of the stored state
String	getSkin() Get the skin associated with the stored state
String	getToolContextPath() Get the Tool Context Path that the state was stored against
String	getToolPathInfo() Get the Path info to the target tool
void	setPlacement(Placement siteTool) set the placement
void	setRequest(javax.servlet.http.HttpServletRequest req) Set the request in the stored state
void	setSkin(String skin) set the skin
void	setToolContextPath(String toolContextPath) set the tool context
void	setToolPathInfo(String toolPathInfo) set the tool path info

Method Detail

getToolContextPath

String getToolContextPath()

Get the Tool Context Path that the state was stored against

Returns:

getRequest

javax.servlet.http.HttpServletRequest getRequest(javax.servlet.http.HttpServletRequest req)

Get the request of the stored state

Parameters:

req -

Returns:

getPlacement

Placement getPlacement()

Get the placement of the stored state

Returns:

getToolPathInfo

String getToolPathInfo()

Get the Path info to the target tool

Returns:

getSkin

String getSkin()

Get the skin associated with the stored state

Returns:

setRequest

void setRequest(javax.servlet.http.HttpServletRequest req)

Set the request in the stored state

Parameters:

req -

setPlacement

void setPlacement(Placement siteTool)

set the placement

Parameters:

siteTool -

setToolContextPath

void setToolContextPath(String toolContextPath)

set the tool context

Parameters:

toolContextPath -

setToolPathInfo

void setToolPathInfo(String toolPathInfo)

set the tool path info

Parameters:

toolPathInfo -

setSkin

void setSkin(String skin)

set the skin

Parameters:

skin -