public interface RenderResponse extends MimeResponse
RenderResponse
defines an object to assist a portlet in
sending a response to the portal. It extends the
MimeResponse
interface to provide specific render
response functionality to portlets.RenderResponse
object and passes it as argument to the
portlet's render
method.RenderRequest
,
PortletResponse
,
MimeResponse
MimeResponse.Copy
CACHE_SCOPE, ETAG, EXPIRATION_CACHE, MARKUP_HEAD_ELEMENT, NAMESPACED_RESPONSE, PRIVATE_SCOPE, PUBLIC_SCOPE, USE_CACHED_CONTENT
Modifier and Type | Method and Description |
---|---|
void |
setContentType(String type)
Sets the MIME type for the render response.
|
void |
setNextPossiblePortletModes(Collection<? extends PortletMode> portletModes)
This method allows the portlet to tell the portal the next possible
portlet modes that the make sense from the portlet point of view.
|
void |
setTitle(String title)
Deprecated.
|
createActionURL, createActionURL, createRenderURL, createRenderURL, createResourceURL, flushBuffer, getBufferSize, getCacheControl, getCharacterEncoding, getContentType, getLocale, getPortletOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize
addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, getProperty, getPropertyNames, getPropertyValues, setProperty
@Deprecated void setTitle(String title)
The value can be a text String
title
- portlet title as text String or resource URIvoid setNextPossiblePortletModes(Collection<? extends PortletMode> portletModes)
If set, the portal should honor these enumeration of portlet modes and only provide the end user with choices to the provided portlet modes or a subset of these modes based on access control considerations.
If the portlet does not set any next possible portlet modes the default is that all portlet modes that the portlet has defined supporting in the portlet deployment descriptor are meaningful new portlet modes.
portletModes
- Enumeration
of objects
of type PortletMode
or any subtype of PortletMode
with the
next possible portlet modes that the make sense from the
portlet point of view, must not be null
or an
empty enumeration.void setContentType(String type)
MimeResponse.getWriter()
or
MimeResponse.getPortletOutputStream()
.
Calling setContentType
after getWriter
or
getOutputStream
does not change the content type.
The portlet container will ignore any character encoding
specified as part of the content type for render
calls.
setContentType
in interface MimeResponse
type
- the content MIME typeIllegalArgumentException
- if the given type is not in the list
returned by PortletRequest.getResponseContentTypes
PortletRequest.getResponseContentTypes()
,
MimeResponse.getContentType()
Java Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.