uk.ac.cam.caret.sakai.rwiki.tool.bean.helper

Class ViewParamsHelperBean

java.lang.Object

uk.ac.cam.caret.sakai.rwiki.tool.bean.helper.ViewParamsHelperBean

public class ViewParamsHelperBean
extends Object

Bean to get common request parameters from the servlet request.

Author:

andrew

Field Summary

Fields

Modifier and Type	Field and Description
static String	SAVE_CANCEL
static String	SAVE_OK
static String	SAVE_PREVIEW
static String	SAVE_VERSION_EXCEPTION

Constructor Summary

Constructors

Constructor and Description
ViewParamsHelperBean()

Method Summary

Methods

Modifier and Type	Method and Description
String	getContent() Get the submitted content
String	getDefaultRealm() Get the default realm
String	getGlobalName() Get the globalised page name
String	getLocalName() Get the localised name relating to globalName and localSpace
String	getLocalSpace() Get the local space
String	getPageSpace() Get the current page's space
String	getSaveState()
String	getSaveType() Get the requested save type
String	getSaveTypeFromParameters(Map parameterMap)
String	getSearch() Get the submitted search criteria
String	getSearchPage()
uk.ac.cam.caret.sakai.rwiki.service.api.RWikiSecurityService	getSecurityService() Get the RWikiSecurityService
ServletRequest	getServletRequest() Get the current servlet request
String	getSubmittedContent() Get the previously submitted content
String	getSubmittedVersion() Get the submitted version number
ToolConfigBean	getToolConfigBean()
String	getWithBreadcrumbs()
void	init() Initializes the bean, gets the parameters out of the request
boolean	isLoadAutoSave()
boolean	isRemoveAutoSave()
void	setContent(String content) Set the content
void	setDefaultRealm(String defaultRealm) Set the default realm
void	setGlobalName(String globalName) Set the globalised page name
void	setLocalSpace(String localSpace) Set the local space
void	setSaveState(String saveState)
void	setSaveType(String saveType) Set the save type
void	setSearch(String search) Set the search criteria
void	setSearchPage(String searchPage)
void	setSecurityService(uk.ac.cam.caret.sakai.rwiki.service.api.RWikiSecurityService securityService) Set the RWikiSecurityService to be used in init
void	setServletRequest(ServletRequest request) Set the current servlet request
void	setSubmittedContent(String submittedContent) Set the previously submitted content
void	setSubmittedVersion(String submittedVersion) Set the submitted version number
void	setToolConfigBean(ToolConfigBean toolConfigBean)
void	setWithBreadcrumbs(String withBreadcrumbs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SAVE_OK

public static final String SAVE_OK

See Also:

Constant Field Values

SAVE_VERSION_EXCEPTION

public static final String SAVE_VERSION_EXCEPTION

See Also:

Constant Field Values

SAVE_CANCEL

public static final String SAVE_CANCEL

See Also:

Constant Field Values

SAVE_PREVIEW

public static final String SAVE_PREVIEW

See Also:

Constant Field Values

Constructor Detail

ViewParamsHelperBean

public ViewParamsHelperBean()

Method Detail

init

public void init()

Initializes the bean, gets the parameters out of the request

getSaveTypeFromParameters

public String getSaveTypeFromParameters(Map parameterMap)

Parameters:

parameterMap -

Returns:

getGlobalName

public String getGlobalName()

Get the globalised page name

Returns:

the requested globalised page name

setGlobalName

public void setGlobalName(String globalName)

Set the globalised page name

Parameters:

globalName -

getLocalSpace

public String getLocalSpace()

Get the local space

Returns:

local space

setLocalSpace

public void setLocalSpace(String localSpace)

Set the local space

Parameters:

localSpace -

getPageSpace

public String getPageSpace()

Get the current page's space

Returns:

space relating to globalName

getLocalName

public String getLocalName()

Get the localised name relating to globalName and localSpace

Returns:

the localised name

getSearch

public String getSearch()

Get the submitted search criteria

Returns:

search criteria

setSearch

public void setSearch(String search)

Set the search criteria

Parameters:

search - criteria to set

getServletRequest

public ServletRequest getServletRequest()

Get the current servlet request

Returns:

current servlet request

setServletRequest

public void setServletRequest(ServletRequest request)

Set the current servlet request

Parameters:

request -

getSecurityService

public uk.ac.cam.caret.sakai.rwiki.service.api.RWikiSecurityService getSecurityService()

Get the RWikiSecurityService

Returns:

the rwikiSecurityService

setSecurityService

public void setSecurityService(uk.ac.cam.caret.sakai.rwiki.service.api.RWikiSecurityService securityService)

Set the RWikiSecurityService to be used in init

Parameters:

securityService -

getDefaultRealm

public String getDefaultRealm()

Get the default realm

Returns:

default realm for the current request

setDefaultRealm

public void setDefaultRealm(String defaultRealm)

Set the default realm

Parameters:

defaultRealm -

getContent

public String getContent()

Get the submitted content

Returns:

content

setContent

public void setContent(String content)

Set the content

Parameters:

content -

getSubmittedContent

public String getSubmittedContent()

Get the previously submitted content

Returns:

content as a String

setSubmittedContent

public void setSubmittedContent(String submittedContent)

Set the previously submitted content

Parameters:

submittedContent -

getSubmittedVersion

public String getSubmittedVersion()

Get the submitted version number

Returns:

version as string

setSubmittedVersion

public void setSubmittedVersion(String submittedVersion)

Set the submitted version number

Parameters:

submittedVersion -

getSaveType

public String getSaveType()

Get the requested save type

Returns:

save type as string

setSaveType

public void setSaveType(String saveType)

Set the save type

Parameters:

saveType -

getWithBreadcrumbs

public String getWithBreadcrumbs()

Returns:

Returns the withBreadcrumbs.

setWithBreadcrumbs

public void setWithBreadcrumbs(String withBreadcrumbs)

Parameters:

withBreadcrumbs - The withBreadcrumbs to set.

getSearchPage

public String getSearchPage()

Returns:

Returns the searchPage.

setSearchPage

public void setSearchPage(String searchPage)

Parameters:

searchPage - The searchPage to set.

getToolConfigBean

public ToolConfigBean getToolConfigBean()

setToolConfigBean

public void setToolConfigBean(ToolConfigBean toolConfigBean)

isRemoveAutoSave

public boolean isRemoveAutoSave()

isLoadAutoSave

public boolean isLoadAutoSave()

getSaveState

public String getSaveState()

Returns:

the saveState

setSaveState

public void setSaveState(String saveState)

Parameters:

saveState - the saveState to set