com.atlassian.jira.portal
Interface PortalManager

All Known Implementing Classes:
DefaultPortalManager

public interface PortalManager


Method Summary
 void createPortalPageConfiguration(User u, java.lang.String pagename)
           
 void deletePortalPageConfiguration(User u, java.lang.String paganame)
          This function removed a portal page configuration for a user including all of its portlet configurations and there properties
 java.util.List getAllPortalPageConfigurations(java.lang.String pagename)
           
 java.util.Collection getAllPortlets()
           
 PortalPageConfiguration getDefaultPortalPage(java.lang.String pagename)
          Returns the default portal page configuration
 PortalPageConfiguration getEditablePortalPageConfiguration(User user, java.lang.String pagename)
           
 PortalPageConfiguration getPortalPageConfiguration(User u, java.lang.String pagename)
           
 Portlet getPortlet(java.lang.String id)
           
 java.util.Collection getPortlets(User user)
          This function returns all the portlets a user has permission to see.
 void resetDefault(java.lang.String pagename)
          This function reloads the default portal page configuration from the database.
 

Method Detail

getPortlet

public Portlet getPortlet(java.lang.String id)

getAllPortlets

public java.util.Collection getAllPortlets()

createPortalPageConfiguration

public void createPortalPageConfiguration(User u,
                                          java.lang.String pagename)
                                   throws PortletConfigurationException
Throws:
PortletConfigurationException

getAllPortalPageConfigurations

public java.util.List getAllPortalPageConfigurations(java.lang.String pagename)
                                              throws PortletConfigurationException
Throws:
PortletConfigurationException

getPortalPageConfiguration

public PortalPageConfiguration getPortalPageConfiguration(User u,
                                                          java.lang.String pagename)
                                                   throws PortletConfigurationException
Throws:
PortletConfigurationException

getDefaultPortalPage

public PortalPageConfiguration getDefaultPortalPage(java.lang.String pagename)
                                             throws PortletConfigurationException
Returns the default portal page configuration

Returns:
Throws:
PortletConfigurationException

deletePortalPageConfiguration

public void deletePortalPageConfiguration(User u,
                                          java.lang.String paganame)
                                   throws PortletConfigurationException
This function removed a portal page configuration for a user including all of its portlet configurations and there properties

Parameters:
u - Owner
paganame - Name of portalpage e.g. dashboard
Throws:
PortletConfigurationException

getPortlets

public java.util.Collection getPortlets(User user)
This function returns all the portlets a user has permission to see.

Parameters:
user - requesting portlets
Returns:
List of portlets for this user

getEditablePortalPageConfiguration

public PortalPageConfiguration getEditablePortalPageConfiguration(User user,
                                                                  java.lang.String pagename)
                                                           throws PortletConfigurationException
Throws:
PortletConfigurationException

resetDefault

public void resetDefault(java.lang.String pagename)
This function reloads the default portal page configuration from the database.

Parameters:
pagename - e.g. dashboard.