com.novell.afw.portlet.api
Interface EbiPortletPreferenceInfo

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

public interface EbiPortletPreferenceInfo

extends EbiFrameworkElement

This interface is for portlet preference info used by potlet producer.

Field Summary

static String

EL_PORTLET_PREFERENCE_INFO portlet instance element type

Method Summary

String	getConsumerID() Gets the consumer ID that this portlet instance has been assigned.
String	getParentPortletHandle() Gets parent portlet handle.
String	getPortletHandle() Gets portlet Handle.
String	getPortletName() Gets portlet Name.
String	getPreferences() Gets the preferences for this portlet instance.
String	getProducerID() Gets the producer ID for this portlet instance.
void	setConsumerID(String consumerID) Sets Consumer ID.
void	setParentPortletHandle(String parentPortletHandle) Sets parent portlet handle.
void	setPortletHandle(String portletHandle) Sets portlet handle.
void	setPortletName(String portletName) Sets portlet Name.
void	setPreferences(String prefXML) Sets preferences for this portlet instance.
void	setProducerID(String producerID) Sets producer ID.

Methods implemented from interface com.sssw.fw.api.EbiFrameworkElement

getElementUUID, getLastModified, getLastModifiedBy, isEqualTo, isReadOnly, resetReadOnly, setLastModified, setLastModifiedBy, setReadOnly

Methods implemented from interface com.sssw.fw.api.EbiElement

getType

Field Detail

EL_PORTLET_PREFERENCE_INFO

public static final String EL_PORTLET_PREFERENCE_INFO

portlet instance element type

Method Detail

getPortletHandle

public String getPortletHandle()

Gets portlet Handle.

Returns:

the portlet handle associated with PortletPrefefenceInfo object.

getPortletName

public String getPortletName()

Gets portlet Name.

Returns:

the portlet Name associated with this portlet preference info object.

getParentPortletHandle

public String getParentPortletHandle()

Gets parent portlet handle.

Returns:

the parent portlet handle.

getPreferences

public String getPreferences()

Gets the preferences for this portlet instance.

Returns:

the preferences for this portlet instance.

getProducerID

public String getProducerID()

Gets the producer ID for this portlet instance. (name spaced to allow multiple producers share the same db).

Returns:

the producerID for this portlet instance.

getConsumerID

public String getConsumerID()

Gets the consumer ID that this portlet instance has been assigned.

Returns:

the consumerID for this portlet instance.

setPortletHandle

public void setPortletHandle(String portletHandle)

Sets portlet handle.

Parameters:

portletHandle - a portlet handle.

setParentPortletHandle

public void setParentPortletHandle(String parentPortletHandle)

Sets parent portlet handle.

Parameters:

ParentPortletHandle - the parent portlet handle.

setPortletName

public void setPortletName(String portletName)

Sets portlet Name.

Parameters:

portletName - a portlet name (defined in portlet.xml for the portlet).

setPreferences

public void setPreferences(String prefXML)

Sets preferences for this portlet instance.

Parameters:

prefXML - an XML String with the preferences.

setProducerID

public void setProducerID(String producerID)

Sets producer ID.

Parameters:

producerID - a producer ID.

setConsumerID

public void setConsumerID(String consumerID)

Sets Consumer ID.

Parameters:

consumerID - a consumer ID.