Source Code Cross Referenced for PortletResponse.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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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 Referenced  Class Diagram Java Document (Java Doc) 


01:        /**
02:         * Copyright 2003 IBM Corporation and Sun Microsystems, Inc.
03:         * All rights reserved.
04:         * Use is subject to license terms.
05:         */package javax.portlet;
06:
07:        /**
08:         * The <CODE>PortletResponse</CODE> defines the base interface to assist a
09:         * portlet in creating and sending a response to the client.
10:         * The portlet container uses two specialized versions of this interface
11:         * when invoking a portlet, <CODE>ActionResponse</CODE> and
12:         * <CODE>RenderResponse</CODE>. The  portlet container creates these
13:         * objects and passes them as arguments to the portlet's <CODE>processAction</CODE>
14:         * and <CODE>render</CODE> methods.
15:         * 
16:         * @see ActionResponse
17:         * @see RenderResponse
18:         */
19:        public interface PortletResponse {
20:
21:            /**
22:             * Adds a String property to an existing key to be returned to the portal.
23:             * <p>
24:             * This method allows response properties to have multiple values.
25:             * <p>
26:             * Properties can be used by portlets to provide vendor specific 
27:             * information to the portal.
28:             *
29:             * @param  key    the key of the property to be returned to the portal
30:             * @param  value  the value of the property to be returned to the portal
31:             *
32:             * @exception  java.lang.IllegalArgumentException 
33:             *                            if key is <code>null</code>.
34:             */
35:
36:            public void addProperty(String key, String value);
37:
38:            /**
39:             * Sets a String property to be returned to the portal.
40:             * <p>
41:             * Properties can be used by portlets to provide vendor specific 
42:             * information to the portal.
43:             * <p>
44:             * This method resets all properties previously added with the same key.
45:             *
46:             * @param  key    the key of the property to be returned to the portal
47:             * @param  value  the value of the property to be returned to the portal
48:             *
49:             * @exception  java.lang.IllegalArgumentException 
50:             *                            if key is <code>null</code>.
51:             */
52:
53:            public void setProperty(String key, String value);
54:
55:            /**
56:             * Returns the encoded URL of the resource, like servlets,
57:             * JSPs, images and other static files, at the given path.
58:             * <p>
59:             * Some portal/portlet-container implementation may require 
60:             * those URLs to contain implementation specific data encoded
61:             * in it. Because of that, portlets should use this method to 
62:             * create such URLs.
63:             * <p>
64:             * The <code>encodeURL</code> method may include the session ID 
65:             * and other portal/portlet-container specific information into the URL. 
66:             * If encoding is not needed, it returns the URL unchanged. 
67:             *
68:             * @param   path
69:             *          the URI path to the resource. This must be either
70:             *          an absolute URL (e.g. 
71:             *          <code>http://my.co/myportal/mywebap/myfolder/myresource.gif</code>)
72:             *          or a full path URI (e.g. <code>/myportal/mywebap/myfolder/myresource.gif</code>).
73:             *
74:             * @exception  java.lang.IllegalArgumentException 
75:             *                            if path doesn't have a leading slash or is not an absolute URL
76:             * 
77:             * @return   the encoded resource URL as string
78:             */
79:
80:            public String encodeURL(String path);
81:
82:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.