com.ibm.workplace.wcm.api
Interface ContextProcessorParams

public interface ContextProcessorParams

Represents the parameters that a context processor is able to read and modify.

Method Summary

java.util.Locale	getCurrentLocale() Returns the current users Locale
java.lang.String	getPortletId() Returns a string which uniquely identifies the current portlet instance
com.ibm.workplace.wcm.api.RenderingContext	getRenderingContext() Returns the WCM API RenderingContext for the current request
com.ibm.workplace.wcm.api.Workspace	getWorkspace() Returns the WCM API Workspace for the current user
void	setRenderingContext(com.ibm.workplace.wcm.api.RenderingContext p_renderingContext) Sets the WCM API RenderingContext for the current request

Method Detail

getWorkspace

public com.ibm.workplace.wcm.api.Workspace getWorkspace()

Returns the WCM API Workspace for the current user

Returns:

the WCM API Workspace for the current user

getCurrentLocale

public java.util.Locale getCurrentLocale()

Returns the current users Locale

Returns:

the current users Locale

getPortletId

public java.lang.String getPortletId()

Returns a string which uniquely identifies the current portlet instance

Returns:

a string which uniquely identifies the current portlet instance

getRenderingContext

public com.ibm.workplace.wcm.api.RenderingContext getRenderingContext()

Returns the WCM API RenderingContext for the current request

This method does not return a copy of the RenderingContext, thus any changes made to the returned RenderingContext will be reflected within this ContextProcessorParams object

Returns:

the WCM API RenderingContext for the current request

setRenderingContext

public void setRenderingContext(com.ibm.workplace.wcm.api.RenderingContext p_renderingContext)

Sets the WCM API RenderingContext for the current request

Parameters:

p_renderingContext - the WCM API RenderingContext for the current request