org.apache.wsrp4j.consumer
Interface WSRPPortlet

All Known Implementing Classes:

WSRPPortletImpl

public interface WSRPPortlet

Defines a consumer-side representation of a remote portlet. A portlet is uniquely identified by its portlet key. Consumer configured portlets are the result of clone operations on existing portlets (parents).

Author:

Stephan Laertz

Method Summary

java.lang.String	getParent() Get the portlet handle of the parent portlet.
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(java.lang.String portletHandle) Set the portlet handle of the parent portlet.
void	setPortletContext(PortletContext portletContext) Set the portlet context of the portlet.
void	setPortletKey(PortletKey portletKey) Set the portlet key of the portlet.

Method Detail

getPortletKey

public PortletKey getPortletKey()

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

Returns:

a portlet key object

setPortletKey

public void setPortletKey(PortletKey portletKey)

Set the portlet key of the portlet.

Parameters:

portletKey - The portlet key of the portlet

getPortletContext

public PortletContext getPortletContext()

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

Returns:

the portlet context object of the portlet.

setPortletContext

public void setPortletContext(PortletContext portletContext)

Set the portlet context of the portlet.

Parameters:

portletContext - The portlet context of the portlet

isConsumerConfigured

public boolean isConsumerConfigured()

Checks if a portlet is consumer configured portlet.

Returns:

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

getParent

public java.lang.String getParent()

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.

Returns:

the portlet handle of the parent portlet.

setParent

public void setParent(java.lang.String portletHandle)

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.

Parameters:

portletHandle - the portlet handle of the parent portlet