Package com.webmethods.caf.portlet.impl

Class ExtendedPortletUrl

java.lang.Object
com.webmethods.caf.portlet.impl.ExtendedPortletUrl
All Implemented Interfaces:
IPortletURL, javax.portlet.PortletURL
public class ExtendedPortletUrl extends Object implements IPortletURL

  • Constructor Details

    • ExtendedPortletUrl

      public ExtendedPortletUrl(javax.portlet.PortletURL portletURL)

  • Method Details

    • setParameter

      public void setParameter(String arg0, String arg1)
      Specified by:
      setParameter in interface javax.portlet.PortletURL

    • setParameter

      public void setParameter(String arg0, String[] arg1)
      Specified by:
      setParameter in interface javax.portlet.PortletURL

    • setParameters

      public void setParameters(Map arg0)
      Specified by:
      setParameters in interface javax.portlet.PortletURL

    • setPortletMode

      public void setPortletMode(javax.portlet.PortletMode arg0) throws javax.portlet.PortletModeException
      Specified by:
      setPortletMode in interface javax.portlet.PortletURL
      Throws:
      javax.portlet.PortletModeException

    • setSecure

      public void setSecure(boolean arg0) throws javax.portlet.PortletSecurityException
      Specified by:
      setSecure in interface javax.portlet.PortletURL
      Throws:
      javax.portlet.PortletSecurityException

    • setWindowState

      public void setWindowState(javax.portlet.WindowState arg0) throws javax.portlet.WindowStateException
      Specified by:
      setWindowState in interface javax.portlet.PortletURL
      Throws:
      javax.portlet.WindowStateException

    • toString

      public String toString()
      Specified by:
      toString in interface javax.portlet.PortletURL
      Overrides:
      toString in class Object

    • setPortlet

      public void setPortlet(String portlet) throws Exception
      Description copied from interface: IPortletURL
      Sets target portlet for this url.
      Specified by:
      setPortlet in interface IPortletURL
      Throws:
      Exception

    • addPortletURL

      public IPortletURL addPortletURL(String anotherPortlet) throws Exception
      Description copied from interface: IPortletURL
      Creates portlet URL for another portlet on the the same target page. The returned url is used for customizing parameters and layout for this other
      Specified by:
      addPortletURL in interface IPortletURL
      Returns:
      the created portlet URL
      Throws:
      Exception

    • clearParameters

      public void clearParameters()
      Description copied from interface: IPortletURL
      Removes all portlet parameters from the URL
      Specified by:
      clearParameters in interface IPortletURL

    • clearState

      public void clearState()
      Description copied from interface: IPortletURL
      Clears the state of the url keeping just the baseUrl
      Specified by:
      clearState in interface IPortletURL

    • getBaseURL

      public String getBaseURL()
      Description copied from interface: IPortletURL
      Returns base url for this portlet url. By default it's current portal resource, i.e. http://myotherportal:8080/<current.resource>
      Specified by:
      getBaseURL in interface IPortletURL
      Returns:
      current base url
      See Also:

    • removeParameter

      public void removeParameter(String name)
      Description copied from interface: IPortletURL
      Removes a portlet paremeter from the URL
      Specified by:
      removeParameter in interface IPortletURL
      Parameters:
      name - the name of the parameter to remove

    • removeParameter

      public void removeParameter(String portlet, String name)
      Description copied from interface: IPortletURL
      Removes parameter from the specified portlet
      Specified by:
      removeParameter in interface IPortletURL
      Parameters:
      portlet - the portlet ID to remove parameter from
      name - parameter name

    • setBaseURL

      public void setBaseURL(String url) throws Exception
      Description copied from interface: IPortletURL
      Sets base url for this portlet url. By default base url is current portal resource, but can be set to any other resource or even any other valid full url like http://myotherportal:8080/portal/alias/ Valid values are: /folder.public /folder.public?p1=p2 http://myotherportal:8080/folder.public?p1=p2&p3=p3
      Specified by:
      setBaseURL in interface IPortletURL
      Throws:
      Exception

    • setParameter

      public void setParameter(String name, String value, boolean encodeValue)
      Description copied from interface: IPortletURL
      Sets portlet parameter String value. Allows to specifiy whether to encode the value. Not encoding the value usually is useful when the url gets some post processing
      Specified by:
      setParameter in interface IPortletURL
      Parameters:
      name - the portlet parameter name
      value - the parameter value
      encodeValue - false to not encode the value.

    • setParameter

      public void setParameter(String name, String[] value, boolean encodeValue)
      Description copied from interface: IPortletURL
      Sets portlet parameter String[] value.. Allows to specifiy whether to encode the value.
      Specified by:
      setParameter in interface IPortletURL
      Parameters:
      name - the portlet parameter name
      value - the parameter value
      encodeValue - false to not encode the value
      See Also:

    • setPortletLayout

      public void setPortletLayout(String pcaLayout) throws Exception
      Description copied from interface: IPortletURL
      Sets PCA layout to display
      Specified by:
      setPortletLayout in interface IPortletURL
      Parameters:
      pcaLayout - the layout to display
      Throws:
      Exception

    • setPortletMethod

      public void setPortletMethod(String pcaMethod) throws Exception
      Description copied from interface: IPortletURL
      Sets PCA method name to invoke on the portlet
      Specified by:
      setPortletMethod in interface IPortletURL
      Parameters:
      pcaMethod - name of the method
      Throws:
      Exception

    • setTargetAction

      public void setTargetAction(String action)
      Description copied from interface: IPortletURL
      Sets target action to execute on the portlet. This has a format of JSF method binding expression. For example #{myportletPageBean.refresh}. This value is only valid for ACTION type portlet urls
      Specified by:
      setTargetAction in interface IPortletURL
      Parameters:
      action - action target JSF method binding expression

    • setTargetView

      public void setTargetView(String view) throws Exception
      Description copied from interface: IPortletURL
      Sets target view to display
      Specified by:
      setTargetView in interface IPortletURL
      Parameters:
      view - name of view to display for a given portlet
      Throws:
      Exception

    • getPortlets

      public List getPortlets()

    • setParameter

      public void setParameter(String portlet, String name, String value, boolean encodeValue)
      Description copied from interface: IPortletURL
      Sets given portlet parameter String value. Allows to specifiy whether to encode the value. Not encoding the value usually is useful when the url gets some post processing
      Specified by:
      setParameter in interface IPortletURL
      name - the portlet parameter name
      value - the parameter value
      encodeValue - false to not encode the value.

    • setParameter

      public void setParameter(String portlet, String name, String[] value, boolean encodeValue)
      Description copied from interface: IPortletURL
      Sets given portlet parameter String[] value.. Allows to specifiy whether to encode the value.
      Specified by:
      setParameter in interface IPortletURL
      name - the portlet parameter name
      value - the parameter value
      encodeValue - false to not encode the value
      See Also:

    • getPortletNamespace

      public String getPortletNamespace(String portlet) throws Exception
      Description copied from interface: IPortletURL
      Returns parameter namespace used for the specified portlet
      Specified by:
      getPortletNamespace in interface IPortletURL
      Returns:
      the portlet namespace for the specified portlet
      Throws:
      Exception

    • removeGlobalParameter

      public void removeGlobalParameter(String name)
      Description copied from interface: IPortletURL
      Removes any global parameters from this url. Global parameters are affecting all portlets being rendered as a result of processing of this url. See IPortletURL.GLOBAL_PARAMETER_KEEP_STATE and IPortletURL.GLOBAL_PARAMETER_RESET_STATE
      Specified by:
      removeGlobalParameter in interface IPortletURL
      Parameters:
      name - global parameter name

    • setGlobalParameter

      public void setGlobalParameter(String name, String value)
      Description copied from interface: IPortletURL
      Sets global parameter for this Url, global parameters are affecting all portlets being rendered as a result of processing of this url. See IPortletURL.GLOBAL_PARAMETER_KEEP_STATE and IPortletURL.GLOBAL_PARAMETER_RESET_STATE
      Specified by:
      setGlobalParameter in interface IPortletURL
      Parameters:
      name - global parameter name
      value - global parameter value

    • setAXSRFT

      public void setAXSRFT(boolean use)
      Description copied from interface: IPortletURL
      True to include anti-cross-site-request-forgery token on url when invoking portlet action; false to omit token.
      Specified by:
      setAXSRFT in interface IPortletURL