Interface IPortletServiceManager

  • All Known Implementing Classes:
    PortletServiceManager

    public interface IPortletServiceManager
    Interface for portlet service manager.
    Since:
    6.0.0
    Version:
    $Revision$ $Date$
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String clonePortlet​(java.lang.String portletHandle, java.lang.String displayName)
      Clones a portlet.
      java.lang.String getDescriptionFromPortlet​(java.lang.String portletHandle)
      Returns the description from portlet.
      com.sun.portal.wsrp.common.stubs.v2.PortletDescription getPortletDescription​(java.lang.String portletHandle)
      Returns the portlet description.
      java.lang.String getPortletName​(java.lang.String portletHandle)
      Returns the portlet name.
      java.util.Properties getPortletProperties​(java.lang.String portletHandle)
      Returns the portlet properties.
      void removeClone​(java.lang.String portletHandle)
      Removes the clone.
      void setPortletProperties​(java.lang.String portletHandle, java.util.Properties properties)
      Sets the portlet properties.
    • Method Detail

      • getPortletName

        java.lang.String getPortletName​(java.lang.String portletHandle)
                                 throws PortalException
        Returns the portlet name.
        Parameters:
        portletHandle - the portlet handle.
        Returns:
        the portlet name.
        Throws:
        PortalException
      • getDescriptionFromPortlet

        java.lang.String getDescriptionFromPortlet​(java.lang.String portletHandle)
                                            throws PortalException
        Returns the description from portlet.
        Parameters:
        portletHandle - the portlet handle.
        Returns:
        the description.
        Throws:
        PortalException
      • getPortletDescription

        com.sun.portal.wsrp.common.stubs.v2.PortletDescription getPortletDescription​(java.lang.String portletHandle)
                                                                              throws PortalException
        Returns the portlet description.
        Parameters:
        portletHandle - the portlet handle.
        Returns:
        an instance of PortletDescription.
        Throws:
        PortalException
      • clonePortlet

        java.lang.String clonePortlet​(java.lang.String portletHandle,
                                      java.lang.String displayName)
                               throws PortalException
        Clones a portlet.
        Parameters:
        portletHandle - the portlet handle.
        displayName - the cloned portlet display name.
        Returns:
        the portletHandle of the cloned portlet.
        Throws:
        PortalException
        Since:
        6.0.0
      • getPortletProperties

        java.util.Properties getPortletProperties​(java.lang.String portletHandle)
                                           throws PortalException
        Returns the portlet properties.
        Parameters:
        producerEntityId - the producer entity id.
        portletHandle - the portlet handle.
        Returns:
        the properties of the portlet.
        Throws:
        PortalException
        Since:
        6.0.0
      • removeClone

        void removeClone​(java.lang.String portletHandle)
                  throws PortalException
        Removes the clone.
        Parameters:
        producerEntityId - the producer entity id.
        portletHandle - the portlet handle.
        Throws:
        PortalException
        Since:
        6.0.0
      • setPortletProperties

        void setPortletProperties​(java.lang.String portletHandle,
                                  java.util.Properties properties)
                           throws PortalException
        Sets the portlet properties.
        Parameters:
        producerEntityId - the producer entity id.
        portletHandle - the portlet handle.
        properties - the new properties.
        Throws:
        PortalException
        Since:
        6.0.0