Java Doc for ActionResponse.java in » Portal » Open-Portal » javax » portlet » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Portal » Open Portal » javax.portlet

Source Cross Reference Class Diagram Java Document (Java Doc)

javax.portlet .ActionResponse

All known Subclasses:   com.sun.portal.portlet.impl .ActionResponseImpl,
ActionResponse
public interface ActionResponse extends PortletResponse(Code)
The ActionResponse interface represents the portlet response to an action request. It extends the PortletResponse interface to provide specific action response functionality to portlets.
The portlet container creates an ActionResponse object and passes it as argument to the portlet's processAction method.
See Also:   ActionRequest
See Also:   PortletResponse

Method Summary
public void sendRedirect(String location)
     Instructs the portlet container to send a redirect response to the client using the specified redirect location URL.
public void setPortletMode(PortletMode portletMode)
     Sets the portlet mode of a portlet to the given portlet mode.
Possible values are the standard portlet modes and any custom portlet modes supported by the portal and the portlet.
public void setRenderParameter(String key, String value)
     Sets a String parameter for the render request.
public void setRenderParameter(String key, String[] values)
     Sets a String array parameter for the render request.
public void setRenderParameters(java.util.Map parameters)
     Sets a parameter map for the render request.
All previously set render parameters are cleared.
These parameters will be accessible in all sub-sequent render calls via the PortletRequest.getParameter call until a new request is targeted to the portlet.
The given parameters do not need to be encoded prior to calling this method.
Parameters:
  parameters - Map containing parameter names for the render phase as keys and parameter values as map values.
public void setWindowState(WindowState windowState)
     Sets the window state of a portlet to the given window state.
Possible values are the standard window states and any custom window states supported by the portal and the portlet.

Method Detail
sendRedirect
public void sendRedirect(String location) throws java.io.IOException(Code)
Instructs the portlet container to send a redirect response to the client using the specified redirect location URL.
This method only accepts an absolute URL (e.g. http://my.co/myportal/mywebap/myfolder/myresource.gif) or a full path URI (e.g. /myportal/mywebap/myfolder/myresource.gif). If required, the portlet container may encode the given URL before the redirection is issued to the client.
The sendRedirect method can not be invoked after any of the following methods of the ActionResponse interface has been called:

setPortletMode
setWindowState
setRenderParameter
setRenderParameters

Parameters:
  location - the redirect location URL
exception:
  java.io.IOException - if an input or output exception occurs.
exception:
  java.lang.IllegalArgumentException - if a relative path URL is given
exception:
  java.lang.IllegalStateException - if the method is invoked after any of above mentioned methods of the ActionResponse interface has been called.

setPortletMode
public void setPortletMode(PortletMode portletMode) throws PortletModeException(Code)
Sets the portlet mode of a portlet to the given portlet mode.
Possible values are the standard portlet modes and any custom portlet modes supported by the portal and the portlet. Portlets must declare in the deployment descriptor the portlet modes they support for each markup type. Standard portlet modes are:

EDIT
HELP
VIEW

Note: The portlet may still be called in a different window state in the next render call, depending on the portlet container / portal.
Parameters:
  portletMode - the new portlet mode
exception:
  PortletModeException - if the portlet cannot switch to this portlet mode,because the portlet or portal does not support it for this markup,or the current user is not allowed to switch to this portlet mode.To avoid this exception the portlet can check the allowedportlet modes with Request.isPortletModeAllowed().
exception:
  java.lang.IllegalStateException - if the method is invoked after sendRedirect has been called.

setRenderParameter
public void setRenderParameter(String key, String value)(Code)
Sets a String parameter for the render request.
These parameters will be accessible in all sub-sequent render calls via the PortletRequest.getParameter call until a request is targeted to the portlet.
This method replaces all parameters with the given key.
The given parameter do not need to be encoded prior to calling this method.
Parameters:
  key - key of the render parameter
Parameters:
  value - value of the render parameter
exception:
  java.lang.IllegalArgumentException - if key or value are null.
exception:
  java.lang.IllegalStateException - if the method is invoked after sendRedirect has been called.

setRenderParameter
public void setRenderParameter(String key, String[] values)(Code)
Sets a String array parameter for the render request.
These parameters will be accessible in all sub-sequent render calls via the PortletRequest.getParameter call until a request is targeted to the portlet.
This method replaces all parameters with the given key.
The given parameter do not need to be encoded prior to calling this method.
Parameters:
  key - key of the render parameter
Parameters:
  values - values of the render parameter
exception:
  java.lang.IllegalArgumentException - if key or value are null.
exception:
  java.lang.IllegalStateException - if the method is invoked after sendRedirect has been called.

setRenderParameters
public void setRenderParameters(java.util.Map parameters)(Code)
Sets a parameter map for the render request.
All previously set render parameters are cleared.
These parameters will be accessible in all sub-sequent render calls via the PortletRequest.getParameter call until a new request is targeted to the portlet.
The given parameters do not need to be encoded prior to calling this method.
Parameters:
  parameters - Map containing parameter names for the render phase as keys and parameter values as map values. The keys in the parametermap must be of type String. The values in the parameter map must be of typeString array (String[]).
exception:
  java.lang.IllegalArgumentException - if parameters is null, ifany of the key/values in the Map are null, if any of the keys is not a String, or if any of the values is not a String array.
exception:
  java.lang.IllegalStateException - if the method is invoked after sendRedirect has been called.

setWindowState
public void setWindowState(WindowState windowState) throws WindowStateException(Code)
Sets the window state of a portlet to the given window state.
Possible values are the standard window states and any custom window states supported by the portal and the portlet. Standard window states are:

MINIMIZED
NORMAL
MAXIMIZED

Parameters:
  windowState - the new portlet window state
exception:
  WindowStateException - if the portlet cannot switch to the specified window state.To avoid this exception the portlet can check the allowedwindow states with Request.isWindowStateAllowed().
exception:
  java.lang.IllegalStateException - if the method is invoked after sendRedirect has been called.
See Also:   WindowState

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.