org.exoplatform.services.wsrp.consumer
Interface PortletKey

All Known Implementing Classes:

PortletKeyAdapter

public interface PortletKey

Defines the information which uniquely identifies an portlet provided by a producer. The portlet key does not identify a use of an portlet

Author:

Stephan Laertz, Benjamin Mestrallet

Method Summary

String	getPortletHandle() Get the portlet handle which identifies an portlet in the scope of one producer
String	getProducerId() Get the ID of the producer providing the portlet
void	setPortletHandle(String portletHandle) Set the portlet handle which identifies an portlet in the scope of one producer
void	setProducerId(String id) Set the ID of the producer providing the portlet

Method Detail

getPortletHandle

String getPortletHandle()

Get the portlet handle which identifies an portlet in the scope of one producer

Returns:

The portlet handle

setPortletHandle

void setPortletHandle(String portletHandle)

Set the portlet handle which identifies an portlet in the scope of one producer

Parameters:

portletHandle - The portlet handle

getProducerId

String getProducerId()

Get the ID of the producer providing the portlet

Returns:

The ID of the producer

setProducerId

void setProducerId(String id)

Set the ID of the producer providing the portlet

Parameters:

id - The ID of the producer