org.jasig.portal.portlet.dao
Interface IPortletDefinitionDao

All Known Implementing Classes:

JpaPortletDefinitionDao

public interface IPortletDefinitionDao

Provides APIs for creating, storing and retrieving IPortletDefinition objects.

Version:

$Revision$

Author:

Eric Dalquist

Method Summary

IPortletDefinition	getPortletDefinition(int channelPublishId) Get an existing portlet definition for the channel publish id.
IPortletDefinition	getPortletDefinition(IPortletDefinitionId portletDefinitionId) Get a IPortletDefinition for the specified IPortletDefinitionId.
void	updatePortletDefinition(IPortletDefinition portletDefinition) Persists changes to a IPortletDefinition.

Method Detail

updatePortletDefinition

void updatePortletDefinition(IPortletDefinition portletDefinition)

Persists changes to a IPortletDefinition.

Parameters:

portletDefinition - The portlet definition to store the changes for

Throws:

IllegalArgumentException - if portletDefinition is null.

getPortletDefinition

IPortletDefinition getPortletDefinition(IPortletDefinitionId portletDefinitionId)

Get a IPortletDefinition for the specified IPortletDefinitionId.

Parameters:

portletDefinitionId - The id to get the definition for.

Returns:

The portlet definition for the id, null if no definition exists for the id.

Throws:

IllegalArgumentException - if portletDefinitionId is null.

getPortletDefinition

IPortletDefinition getPortletDefinition(int channelPublishId)

Get an existing portlet definition for the channel publish id. If no definition exists for the id null will be returned.

Parameters:

channelPublishId - The id of the org.jasig.portal.ChannelDefinition this portlet definition represents.

Returns:

The portlet definition for the channelPublishId, null if no definition exists for the id.

Throws:

IllegalArgumentException - If channelPublishId is null.