Package org.gatein.pc.controller.request

Class PortletResourceRequest

java.lang.Object

org.gatein.pc.controller.request.ControllerRequest

org.gatein.pc.controller.request.ContainerRequest

org.gatein.pc.controller.request.PortletResourceRequest

public class PortletResourceRequest
extends ContainerRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PortletResourceRequest.FullScope
static class	PortletResourceRequest.PageScope
static class	PortletResourceRequest.PortletScope
static class	PortletResourceRequest.Scope

Field Summary

Fields inherited from class org.gatein.pc.controller.request.ContainerRequest

windowId

Constructor Summary

Constructors

Constructor	Description
PortletResourceRequest(String windowId, String resourceId, org.gatein.pc.api.StateString resourceState, Map<String,String[]> bodyParameters, PortletResourceRequest.Scope scope)	Build a new portlet resource request.

Method Summary

Modifier and Type	Method	Description
Map<String,String[]>	getBodyParameters()
org.gatein.pc.api.cache.CacheLevel	getCacheability()
PageNavigationalState	getPageNavigationalState()	Returns the page navigational state or null if that kind of request cannot have one.
String	getResourceId()
org.gatein.pc.api.StateString	getResourceState()
PortletResourceRequest.Scope	getScope()
org.gatein.pc.api.invocation.response.PortletInvocationResponse	invoke(ControllerContext context)

Methods inherited from class org.gatein.pc.controller.request.ContainerRequest

getWindowId

Methods inherited from class java.lang.Object

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

Constructor Details

PortletResourceRequest

public PortletResourceRequest(String windowId,
 String resourceId,
 org.gatein.pc.api.StateString resourceState,
 Map<String,String[]> bodyParameters,
 PortletResourceRequest.Scope scope)
                       throws IllegalArgumentException

Build a new portlet resource request.

Parameters:

windowId - the window id

resourceId - the resource id

resourceState - the resource state

bodyParameters - the body parameters

scope - the scope

Throws:

IllegalArgumentException - if the windows id, the resource state or the scope is null

Method Details

getScope

public PortletResourceRequest.Scope getScope()

getCacheability

public org.gatein.pc.api.cache.CacheLevel getCacheability()

getResourceId

public String getResourceId()

getResourceState

public org.gatein.pc.api.StateString getResourceState()

getBodyParameters

public Map<String,String[]> getBodyParameters()

getPageNavigationalState

public PageNavigationalState getPageNavigationalState()

Description copied from class: ControllerRequest

Returns the page navigational state or null if that kind of request cannot have one.

Specified by:

getPageNavigationalState in class ControllerRequest

Returns:

the page state

invoke

public org.gatein.pc.api.invocation.response.PortletInvocationResponse invoke(ControllerContext context)
                                                                       throws org.gatein.pc.api.PortletInvokerException

Specified by:

invoke in class ControllerRequest

Throws:

org.gatein.pc.api.PortletInvokerException