portletspec3
  1. portletspec3
  2. PORTLETSPEC3-9

Errata: Clarification needed for method MimeResponse.createRenderURL

    Details

      Description

      The description contains a statement that I believe to be incorrect. It states:

      "The created URL will per default not contain any parameters of the current render request."

      However, the created URL I believe must contain any public render parameters that were set on
      the request. Also, the term "current render request" may be misleading. What is meant is the
      request that is being executed when the URL is created.

      So I would propose the following update:

      Original:
      -------------------------
      createRenderURL

      PortletURL createRenderURL()

      Creates a portlet URL targeting the portlet. If no portlet mode, window state or security modifier is set in the PortletURL the current values are preserved. If a request is triggered by the PortletURL, it results in a render request.

      The returned URL can be further extended by adding portlet-specific parameters and portlet modes and window states.

      The created URL will per default not contain any parameters of the current render request.

      Returns:
      a portlet render URL
      -------------------------

      Corrected:
      -------------------------
      createRenderURL

      PortletURL createRenderURL()

      Creates a portlet URL targeting the portlet. If no portlet mode, window state or security modifier is set in the PortletURL the current values are preserved. If a request is triggered by the PortletURL, it results in a render request.

      The returned URL can be further extended by adding portlet-specific parameters and portlet modes and window states.

      The created URL will per default contain only the public render parameters from the request
      being executed when the render URL is created.

      Returns:
      a portlet render URL
      -------------------------

      The same change should be made for the MimeResponse.createActionURL method.

        Activity

        No work has yet been logged on this issue.

          People

          • Assignee:
            msnicklous
            Reporter:
            msnicklous
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: