com.atlassian.jira.portal
Interface PortletConfigurationStore

All Known Implementing Classes:
CachingPortletConfigurationStore, OfbizPortletConfigurationStore

public interface PortletConfigurationStore

Store for the PortletConfiguration domain object.


Method Summary
 PortletConfiguration add(Long pageId, String portletKey, Integer column, Integer row)
          Creates and adds a new PortletConfiguration to given PortalPage
 void delete(PortletConfiguration pc)
          Deletes the given PortletConfiguration.
 List getByPortalPage(Long portalPageId)
          Get all PortletConfiguration objects for a given PortalPage id.
 PortletConfiguration getByPortletId(Long portletId)
          Gall a PortletConfiguration by its id.
 void store(PortletConfiguration pc)
          Saves the given PortletConfiguration.
 

Method Detail

getByPortalPage

List getByPortalPage(Long portalPageId)
Get all PortletConfiguration objects for a given PortalPage id.

Parameters:
portalPageId - The id of the page to retreive all configurations for.
Returns:
The configurations associated with the given page.

getByPortletId

PortletConfiguration getByPortletId(Long portletId)
Gall a PortletConfiguration by its id.

Parameters:
portletId - The id of the portlet configuration
Returns:
The configuration of the given id.

delete

void delete(PortletConfiguration pc)
Deletes the given PortletConfiguration.

Parameters:
pc - The PortletConfiguration to delete.

store

void store(PortletConfiguration pc)
Saves the given PortletConfiguration.

Parameters:
pc - The PortletConfiguration to save.

add

PortletConfiguration add(Long pageId,
                         String portletKey,
                         Integer column,
                         Integer row)
Creates and adds a new PortletConfiguration to given PortalPage

Parameters:
pageId - The id of the page to add the configuration to.
portletKey - The key of the portlet.
column - The column position of the portlet.
row - The row position of the portlet
Returns:
The new PortletConfiguration with the id set.


Copyright © 2002-2009 Atlassian. All Rights Reserved.