Package javax.portlet

Interface RenderResponse

  • All Superinterfaces:
    MimeResponse, PortletResponse
    All Known Implementing Classes:
    RenderResponseWrapper

    public interface RenderResponse
    extends MimeResponse
    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
    • Method Detail

      • setTitle

        void setTitle​(java.lang.String title)
        This method sets the title of the portlet.

        The value can be a text String

        Parameters:
        title - portlet title as text String or resource URI
      • setNextPossiblePortletModes

        void setNextPossiblePortletModes​(java.util.Collection<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 - Enumeration of PortletMode objects 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