org.osivia.portal.api.customization

Interface IProjectCustomizationConfiguration

public interface IProjectCustomizationConfiguration

Project customization configuration interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOMIZER_ATTRIBUTE_CONFIGURATION Project customizer configuration attribute name.
static String	CUSTOMIZER_ID Project customizer identifier.

Method Summary

Modifier and Type	Method and Description
String	buildRestorableURL() get URL to replay once redirection is done
String	getCMSPath() Get current CMS path.
javax.servlet.http.HttpServletRequest	getHttpServletRequest() Get HTTP servlet request.
javax.servlet.http.HttpServletResponse	getHttpServletResponse() Get HTTP servlet response.
org.jboss.portal.core.model.portal.Page	getPage() Get current page.
String	getThemeName() Get theme name.
String	getWebId() Get current web identifier.
boolean	isAdministrator() Get administrator indicator.
boolean	isBeforeInvocation() Check if customization occurs before invocation.
void	setRedirectionURL(String redirectionURL) Set portal redirection URL.

Field Detail

CUSTOMIZER_ID

static final String CUSTOMIZER_ID

Project customizer identifier.

See Also:

Constant Field Values

CUSTOMIZER_ATTRIBUTE_CONFIGURATION

static final String CUSTOMIZER_ATTRIBUTE_CONFIGURATION

Project customizer configuration attribute name.

See Also:

Constant Field Values

Method Detail

getCMSPath

String getCMSPath()

Get current CMS path.

Returns:

CMS path

getWebId

String getWebId()

Get current web identifier.

Returns:

web identifiers

getPage

org.jboss.portal.core.model.portal.Page getPage()

Get current page.

Returns:

page

isBeforeInvocation

boolean isBeforeInvocation()

Check if customization occurs before invocation.

Returns:

true if customization occurs before invocation

getHttpServletRequest

javax.servlet.http.HttpServletRequest getHttpServletRequest()

Get HTTP servlet request.

Returns:

HTTP servlet request

getHttpServletResponse

javax.servlet.http.HttpServletResponse getHttpServletResponse()

Get HTTP servlet response.

Returns:

HTTP servlet response

getThemeName

String getThemeName()

Get theme name.

Returns:

theme name

isAdministrator

boolean isAdministrator()

Get administrator indicator.

Returns:

administrator indicator

setRedirectionURL

void setRedirectionURL(String redirectionURL)

Set portal redirection URL.

Parameters:

redirectionURL - redirection URL

buildRestorableURL

String buildRestorableURL()

get URL to replay once redirection is done

Parameters:

redirectionURL - redirection URL