OpenSymphony - PortletResult (WebWork API

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.opensymphony.webwork.portlet.result
Class PortletResult

java.lang.Object
  com.opensymphony.webwork.dispatcher.WebWorkResultSupport
      com.opensymphony.webwork.portlet.result.PortletResult

All Implemented Interfaces:: WebWorkStatics, Result, Serializable

public class PortletResult
extends WebWorkResultSupport
extends WebWorkResultSupport

Result type that includes a JSP to render.

Version:: $Revision: 2338 $
Author:: Nils-Helge Garli, Rainer Hermanns
See Also:: Serialized Form

Field Summary

Fields inherited from class com.opensymphony.webwork.dispatcher.WebWorkResultSupport

DEFAULT_PARAM, encode, location, parse

Fields inherited from interface com.opensymphony.webwork.WebWorkStatics

HTTP_REQUEST, HTTP_RESPONSE, PAGE_CONTEXT, SERVLET_CONTEXT, SERVLET_DISPATCHER

Constructor Summary

PortletResult()


Method Summary

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

void doExecute(String finalLocation, ActionInvocation actionInvocation)
          Execute the result.

protected void executeActionResult(String finalLocation, ActionInvocation invocation)
          Executes the action result.

protected void executeRenderResult(String finalLocation)
          Executes the render result.

void setContentType(String contentType)
          Sets the content type.

void setTitle(String title)
          Sets the title.

Methods inherited from class com.opensymphony.webwork.dispatcher.WebWorkResultSupport

conditionalParse, execute, setEncode, setLocation, setParse

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletResult

public PortletResult()

Method Detail

doExecute

public void doExecute(String finalLocation,
                      ActionInvocation actionInvocation)
               throws Exception

Execute the result. Obtains the PortletRequestDispatcherfrom the PortletActionContextand includes the JSP.

Specified by:: doExecute in class WebWorkResultSupport

Parameters:: finalLocation - the location (jsp page, action, etc) to go to.; actionInvocation - the execution state of the action.
Throws:: Exception - if an error occurs while executing the result.
See Also:: Result.execute(com.opensymphony.xwork.ActionInvocation)

executeActionResult

protected void executeActionResult(String finalLocation,
                                   ActionInvocation invocation)

Executes the action result.

Parameters:: finalLocation -; invocation -

convertQueryParamsToRenderParams

protected static void convertQueryParamsToRenderParams(javax.portlet.ActionResponse response,
                                                       String queryParams)

Converts the query params to render params.

Parameters:: response -; queryParams -

executeRenderResult

protected void executeRenderResult(String finalLocation)
                            throws javax.portlet.PortletException,
                                   IOException

Executes the render result.

Parameters:: finalLocation -
Throws:: javax.portlet.PortletException; IOException

setContentType

public void setContentType(String contentType)

Sets the content type.

Parameters:: contentType - The content type to set.

setTitle

public void setTitle(String title)

Sets the title.

Parameters:: title - The title to set.