org.apache.struts2.portlet.result
Class PortletResult

java.lang.Object
  extended by org.apache.struts2.dispatcher.StrutsResultSupport
      extended by org.apache.struts2.portlet.result.PortletResult
All Implemented Interfaces:
Result, java.io.Serializable, PortletActionConstants, StrutsStatics
Direct Known Subclasses:
PortletActionRedirectResult

public class PortletResult
extends StrutsResultSupport
implements PortletActionConstants

Result type that includes a JSP to render.

See Also:
Serialized Form

Field Summary
protected  javax.portlet.PortletMode portletMode
           
 
Fields inherited from class org.apache.struts2.dispatcher.StrutsResultSupport
DEFAULT_PARAM
 
Fields inherited from interface org.apache.struts2.portlet.PortletActionConstants
ACTION_MAPPING, ACTION_PARAM, ACTION_RESET, DEFAULT_ACTION_FOR_MODE, DEFAULT_ACTION_NAME, DEFAULT_DISPATCHER_SERVLET_NAME, DISPATCH_TO, ERROR_ACTION, EVENT_ACTION, EVENT_PHASE, MODE_NAMESPACE_MAP, MODE_PARAM, PHASE, PORTLET_CONFIG, PORTLET_NAMESPACE, RENDER_DIRECT_LOCATION, RENDER_PHASE, REQUEST, RESPONSE, STACK_FROM_EVENT_PHASE
 
Fields inherited from interface org.apache.struts2.StrutsStatics
HTTP_REQUEST, HTTP_RESPONSE, PAGE_CONTEXT, SERVLET_CONTEXT, SERVLET_DISPATCHER, STRUTS_ACTION_TAG_INVOCATION, STRUTS_PORTLET_CONTEXT
 
Constructor Summary
PortletResult()
           
PortletResult(java.lang.String location)
           
 
Method Summary
protected static void convertQueryParamsToRenderParams(javax.portlet.ActionResponse response, java.lang.String queryParams)
          Converts the query params to render params.
 void doExecute(java.lang.String finalLocation, ActionInvocation actionInvocation)
          Execute the result.
protected  void executeActionResult(java.lang.String finalLocation, ActionInvocation invocation)
          Executes the action result.
protected  void executeRenderResult(java.lang.String finalLocation)
          Executes the render result.
 void setContentType(java.lang.String contentType)
          Sets the content type.
 void setDispatcherServletName(java.lang.String dispatcherServletName)
           
 void setPortletMode(java.lang.String portletMode)
           
 void setTitle(java.lang.String title)
          Sets the title.
 void setUseDispatcherServlet(java.lang.String useDispatcherServlet)
           
 
Methods inherited from class org.apache.struts2.dispatcher.StrutsResultSupport
conditionalParse, execute, getLastFinalLocation, getLocation, setEncode, setLocation, setParse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

portletMode

protected javax.portlet.PortletMode portletMode
Constructor Detail

PortletResult

public PortletResult()

PortletResult

public PortletResult(java.lang.String location)
Method Detail

doExecute

public void doExecute(java.lang.String finalLocation,
                      ActionInvocation actionInvocation)
               throws java.lang.Exception
Execute the result. Obtains the PortletRequestDispatcherfrom the PortletActionContextand includes the JSP.

Specified by:
doExecute in class StrutsResultSupport
Throws:
java.lang.Exception
See Also:
Result.execute(com.opensymphony.xwork2.ActionInvocation)

executeActionResult

protected void executeActionResult(java.lang.String finalLocation,
                                   ActionInvocation invocation)
                            throws java.lang.Exception
Executes the action result.

Parameters:
finalLocation -
invocation -
Throws:
java.lang.Exception

convertQueryParamsToRenderParams

protected static void convertQueryParamsToRenderParams(javax.portlet.ActionResponse response,
                                                       java.lang.String queryParams)
Converts the query params to render params.

Parameters:
response -
queryParams -

executeRenderResult

protected void executeRenderResult(java.lang.String finalLocation)
                            throws javax.portlet.PortletException,
                                   java.io.IOException
Executes the render result.

Parameters:
finalLocation -
Throws:
javax.portlet.PortletException
java.io.IOException

setContentType

public void setContentType(java.lang.String contentType)
Sets the content type.

Parameters:
contentType - The content type to set.

setTitle

public void setTitle(java.lang.String title)
Sets the title.

Parameters:
title - The title to set.

setPortletMode

public void setPortletMode(java.lang.String portletMode)

setUseDispatcherServlet

public void setUseDispatcherServlet(java.lang.String useDispatcherServlet)

setDispatcherServletName

public void setDispatcherServletName(java.lang.String dispatcherServletName)


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.