org.apache.wsrp4j.consumer.driver
Class WSRPPortletImpl

java.lang.Object
  org.apache.wsrp4j.util.StateChangedServiceImpl
      org.apache.wsrp4j.consumer.driver.WSRPPortletImpl

All Implemented Interfaces:

StateChangedService, WSRPPortlet

public class WSRPPortletImpl

extends StateChangedServiceImpl

implements WSRPPortlet

Implements the portlet interface

Version:

$Id: WSRPPortletImpl.java,v 1.5 2005/08/10 14:51:44 cziegeler Exp $

Field Summary

private java.lang.String	parentHandle
private oasis.names.tc.wsrp.v1.types.PortletContext	portletContext
private PortletKey	portletKey

Fields inherited from class org.apache.wsrp4j.util.StateChangedServiceImpl

Constructor Summary

WSRPPortletImpl()

WSRPPortletImpl(PortletKey portletKey)

Method Summary

java.lang.String	getParent() Get the portlet handle of the parent portlet.
oasis.names.tc.wsrp.v1.types.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(oasis.names.tc.wsrp.v1.types.PortletContext portletContext) Set the portlet context of the portlet.
void	setPortletKey(PortletKey portletKey) Set the portlet key of the portlet.

Methods inherited from class org.apache.wsrp4j.util.StateChangedServiceImpl

addListener, stateChanged

Methods inherited from class java.lang.Object

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

Field Detail

portletKey

private PortletKey portletKey

portletContext

private oasis.names.tc.wsrp.v1.types.PortletContext portletContext

parentHandle

private java.lang.String parentHandle

Constructor Detail

WSRPPortletImpl

public WSRPPortletImpl()

WSRPPortletImpl

public WSRPPortletImpl(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(oasis.names.tc.wsrp.v1.types.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 oasis.names.tc.wsrp.v1.types.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 java.lang.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(java.lang.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.