org.exoplatform.services.wsrp.consumer.adapters
Class WSRPPortletAdapter

java.lang.Object
  org.exoplatform.services.wsrp.consumer.adapters.WSRPPortletAdapter

All Implemented Interfaces:

WSRPPortlet

public class WSRPPortletAdapter
extends Object
implements WSRPPortlet

Constructor Summary

WSRPPortletAdapter(PortletKey portletKey)

Method Summary

String	getParent() Get the portlet handle of the parent portlet.
org.exoplatform.services.wsrp.type.PortletContext	getPortletContext() Get the portlet context object which contains information about the portlet state.
PortletKey	getPortletKey() Get the portlet key of the portlet.
boolean	isConsumerConfigured() Checks if a portlet is consumer configured portlet.
void	setParent(String portletHandle) Set the portlet handle of the parent portlet.
void	setPortletContext(org.exoplatform.services.wsrp.type.PortletContext portletContext) Set the portlet context of the portlet.
void	setPortletKey(PortletKey portletKey) Set the portlet key of the portlet.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WSRPPortletAdapter

public WSRPPortletAdapter(PortletKey portletKey)

Method Detail

getPortletKey

public PortletKey getPortletKey()

Description copied from interface: WSRPPortlet

Get the portlet key of the portlet. The key can be used to reference to the portlet.

Specified by:

getPortletKey in interface WSRPPortlet

Returns:

a portlet key object

setPortletKey

public void setPortletKey(PortletKey portletKey)

Description copied from interface: WSRPPortlet

Set the portlet key of the portlet.

Specified by:

setPortletKey in interface WSRPPortlet

Parameters:

portletKey - The portlet key of the portlet

setPortletContext

public void setPortletContext(org.exoplatform.services.wsrp.type.PortletContext portletContext)

Description copied from interface: WSRPPortlet

Set the portlet context of the portlet.

Specified by:

setPortletContext in interface WSRPPortlet

Parameters:

portletContext - The portlet context of the portlet

getPortletContext

public org.exoplatform.services.wsrp.type.PortletContext getPortletContext()

Description copied from interface: WSRPPortlet

Get the portlet context object which contains information about the portlet state.

Specified by:

getPortletContext in interface WSRPPortlet

Returns:

the portlet context object of the portlet.

getParent

public String getParent()

Description copied from interface: WSRPPortlet

Get the portlet handle of the parent portlet. If the portlet is not a consumer configured portlet the handle returned by this method should be the same as the handle in the portlet key returned by getPortletKey.

Specified by:

getParent in interface WSRPPortlet

Returns:

the portlet handle of the parent portlet.

setParent

public void setParent(String portletHandle)

Description copied from interface: WSRPPortlet

Set the portlet handle of the parent portlet. If the supplied handle is not equal to the handle in the portlet key returned by getPortletKey this method makes the portlet a consumer configured portlet.

Specified by:

setParent in interface WSRPPortlet

Parameters:

portletHandle - the portlet handle of the parent portlet

isConsumerConfigured

public boolean isConsumerConfigured()

Description copied from interface: WSRPPortlet

Checks if a portlet is consumer configured portlet.

Specified by:

isConsumerConfigured in interface WSRPPortlet

Returns:

True if the result getParent() is not equal to the portlet handle of the portlet key.