Package lumis.service.wsrp.consumer

Interface RemotePortletManagementManager

All Known Implementing Classes:

RemotePortletManagementManagerV1, RemotePortletManagementManagerV2

public interface RemotePortletManagementManager

Interface for remote portlet manager.

Since:

6.0.0

Version:

$Revision: 13092 $ $Date: 2011-05-28 18:19:06 -0300 (Sat, 28 May 2011) $

Method Summary

Modifier and Type	Method	Description
String	clonePortlet(String portletHandle)	Clones a portlet.
String	getDescriptionFromPortlet(String portletHandle)	Returns the description from portlet.
com.sun.portal.wsrp.common.stubs.v2.PortletDescription	getPortletDescription(String portletHandle)	Returns the PortletDescription for the given portletHandle.
String	getPortletName(String portletHandle)	Returns the portlet display name.
Properties	getPortletProperties(String portletHandle)	Returns the portlet properties.
String	getPortletPropertyDescription(String portletHandle, String propertyName)	Returns the portlet property description.
void	removeClone(String portletHandle)	Removes the clone.
void	setPortletProperties(String portletHandle, Properties properties)	Sets the portlet properties.

Method Detail

getPortletName

String getPortletName(String portletHandle)
               throws PortalException

Returns the portlet display name.

Parameters:

portletHandle - the portlet handle.

Returns:

the portlet display name.

Throws:

PortalException

Since:

6.0.0

getDescriptionFromPortlet

String getDescriptionFromPortlet(String portletHandle)
                          throws PortalException

Returns the description from portlet.

Parameters:

portletHandle - the portlet handle.

Returns:

the description from portlet.

Throws:

PortalException

Since:

6.0.0

getPortletDescription

com.sun.portal.wsrp.common.stubs.v2.PortletDescription getPortletDescription(String portletHandle)
                                                                      throws PortalException

Returns the PortletDescription for the given portletHandle.

Parameters:

portletHandle - the portlet handle.

Returns:

the PortletDescription.

Throws:

PortalException

Since:

6.0.0

clonePortlet

String clonePortlet(String portletHandle)
             throws PortalException

Clones a portlet.

Parameters:

producerEntityId - the producer entity id.

portletHandle - the portlet handle.

Returns:

the portletHandle of the cloned portlet.

Throws:

PortalException

Since:

6.0.0

getPortletProperties

Properties getPortletProperties(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

getPortletPropertyDescription

String getPortletPropertyDescription(String portletHandle,
                                     String propertyName)
                              throws PortalException

Returns the portlet property description.

Parameters:

producerEntityId - the producer entity id.

portletHandle - the portlet handle.

propertyName - the property name.

Returns:

the portlet property description.

Throws:

PortalException

Since:

6.0.0

removeClone

void removeClone(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(String portletHandle,
                          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