org.jasig.portal.portlet.om
Interface IPortletEntity

public interface IPortletEntity

A portlet entity represents what a user subscribes to (adds to their layout) in the portal object model.

Version:

$Revision$

Author:

Eric Dalquist

Method Summary

String	getChannelSubscribeId()
IPortletDefinitionId	getPortletDefinitionId()
IPortletEntityId	getPortletEntityId()
IPortletPreferences	getPortletPreferences()
int	getUserId()
void	setPortletPreferences(IPortletPreferences portletPreferences)

Method Detail

getPortletEntityId

IPortletEntityId getPortletEntityId()

Returns:

The unique identifier for this portlet entity.

getPortletDefinitionId

IPortletDefinitionId getPortletDefinitionId()

Returns:

The ID of the parent portlet defintion

getChannelSubscribeId

String getChannelSubscribeId()

Returns:

The subscribe ID for the channel underlying this entity.

getUserId

int getUserId()

Returns:

The ID of the user this entity is for.

getPortletPreferences

IPortletPreferences getPortletPreferences()

Returns:

The preferences for this portlet entity, will not be null.

setPortletPreferences

void setPortletPreferences(IPortletPreferences portletPreferences)

Parameters:

portletPreferences - The preferences for this portlet entity.

Throws:

IllegalArgumentException - If preferences is null.