oracle.webcenter.portal.runtime.context

Class PortalRequestContext

java.lang.Object

oracle.webcenter.portal.runtime.context.PortalRequestContext

public abstract class PortalRequestContext
extends java.lang.Object

PortalRequestContext is an abstract class for accessing runtime context data.

Typically used by consumers of the Portal Persistence API. An instance of this class can be obtained using the getInstance() method.

The context object is created and set up at runtime by the PortalRuntimePhaseListener.

Constructor Summary

Constructors

Constructor and Description
PortalRequestContext()

Method Summary

Modifier and Type	Method and Description
abstract BasePage<? extends BasePagePropertyBean>	getCurrentBasePage() Returns the Current Page object from the PortalRequestContext.
static PortalRequestContext	getInstance() Returns the PortalRequestContext.
abstract java.lang.String	getPhysicalURI() Returns the physical URI for the current request.
abstract PortalObjectRepository	getPortalObjectRepository() Gets the PortalObjectRepository
abstract ManagedPortalObject	getRenderTargetObject() Returns the portal object that is being rendered in order to display the current target portal object.
abstract ManagedPortalObject	getTargetObject() Returns the portal object targeted by the current URL from the PortalRequestContext.
abstract URLGenerator	getURLGenerator() Gets the URLGenerator.
abstract java.lang.String	getViewId() Returns the view ID for the current request.
abstract void	setCurrentBasePage(BasePage<? extends BasePagePropertyBean> page) Sets the Current Page object in the PortalRequestContext.
static void	setInstance(PortalRequestContext ctx) Sets the PortalRequestContext.
abstract void	setPhysicalURI(java.lang.String uri) Sets the physical URI for the current request.
abstract void	setRenderTargetObject(ManagedPortalObject renderTargetObject) Sets the portal object that is being rendered in order to display the current target portal object.
abstract void	setTargetObject(ManagedPortalObject targetObject) Sets the portal object targeted by the current URL from the PortalRequestContext.
abstract void	setViewId(java.lang.String viewId) Sets the view ID for the current request.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortalRequestContext

public PortalRequestContext()

Method Detail

getInstance

public static PortalRequestContext getInstance()

Returns the PortalRequestContext.

Returns:

the Portal Request Context.

setInstance

public static void setInstance(PortalRequestContext ctx)

Sets the PortalRequestContext. This method is typically invoked by the phase listener PortalRuntimePhaseListener.

Parameters:

ctx -

getCurrentBasePage

public abstract BasePage<? extends BasePagePropertyBean> getCurrentBasePage()

Returns the Current Page object from the PortalRequestContext.

Returns:

the Current Page object.

setCurrentBasePage

public abstract void setCurrentBasePage(BasePage<? extends BasePagePropertyBean> page)

Sets the Current Page object in the PortalRequestContext.

Parameters:

page - the Current Page object.

getTargetObject

public abstract ManagedPortalObject getTargetObject()

Returns the portal object targeted by the current URL from the PortalRequestContext.

Returns:

the current target portal object.

setTargetObject

public abstract void setTargetObject(ManagedPortalObject targetObject)

Sets the portal object targeted by the current URL from the PortalRequestContext.

Parameters:

targetObject - the current target portal object.

getRenderTargetObject

public abstract ManagedPortalObject getRenderTargetObject()

Returns the portal object that is being rendered in order to display the current target portal object.

Returns:

the current render target portal object.

setRenderTargetObject

public abstract void setRenderTargetObject(ManagedPortalObject renderTargetObject)

Sets the portal object that is being rendered in order to display the current target portal object.

Parameters:

renderTargetObject - the current render target portal object.

getPhysicalURI

public abstract java.lang.String getPhysicalURI()

Returns the physical URI for the current request.

Returns:

the current physical URI

setPhysicalURI

public abstract void setPhysicalURI(java.lang.String uri)

Sets the physical URI for the current request.

Parameters:

uri - the current physical URI.

getViewId

public abstract java.lang.String getViewId()

Returns the view ID for the current request.

Returns:

the current view ID

setViewId

public abstract void setViewId(java.lang.String viewId)

Sets the view ID for the current request.

Parameters:

viewId - the current view ID

getURLGenerator

public abstract URLGenerator getURLGenerator()

Gets the URLGenerator.

Returns:

The URLGenerator instance for this request.

getPortalObjectRepository

public abstract PortalObjectRepository getPortalObjectRepository()

Gets the PortalObjectRepository

Returns:

The PortalObjectRepository instance for this request.