Top Description Fields Methods
javax.portlet

public Interface RenderResponse

extends MimeResponse
Known Direct Implementers
javax.portlet.filter.RenderResponseWrapper
The 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.
The portlet container creates a RenderResponse object and passes it as argument to the portlet's render method.
See Also
RenderRequest, PortletResponse, MimeResponse

Field Summary

Inherited from javax.portlet.MimeResponse:
CACHE_SCOPEETAGEXPIRATION_CACHEMARKUP_HEAD_ELEMENTNAMESPACED_RESPONSEPRIVATE_SCOPEPUBLIC_SCOPEUSE_CACHED_CONTENT

Method Summary

Modifier and TypeMethod and Description
public void
setContentType(String
the content MIME type
type)

Redeclares javax.portlet.MimeResponse.setContentType.

Sets the MIME type for the render response.
public void
setNextPossiblePortletModes(Collection<? extends PortletMode>
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.
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.

public void
setTitle(String
portlet title as text String or resource URI
title)

Deprecated
This method sets the title of the portlet.
Inherited from javax.portlet.MimeResponse:
createActionURLcreateActionURLcreateRenderURLcreateRenderURLcreateResourceURLflushBuffergetBufferSizegetCacheControlgetCharacterEncodinggetContentTypegetLocalegetPortletOutputStreamgetWriterisCommittedresetresetBuffersetBufferSize

Method Detail

setContentTypeback to summary
public void setContentType(String type)

Redeclares javax.portlet.MimeResponse.setContentType.

Sets the MIME type for the render response. The portlet should set the content type before calling getWriter or 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.

Parameters
type:String

the content MIME type

Exceptions
IllegalArgumentException:
if the given type is not in the list returned by PortletRequest.getResponseContentTypes
See Also
PortletRequest#getResponseContentTypes, getContentType
setNextPossiblePortletModesback to summary
public 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.

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.

Parameters
portletModes:Collection<? extends PortletMode>

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.

Since
2.0
setTitleback to summary
public void setTitle(String title)

Deprecated

This method sets the title of the portlet.

The value can be a text String

Parameters
title:String

portlet title as text String or resource URI

Annotations
@Deprecated