com.atlassian.jira.portal
Interface PortalManager

All Known Implementing Classes:
AbstractPortalManager

public interface PortalManager


Field Summary
static java.lang.String DASHBOARD_PAGE_NAME
           
static java.lang.String SYSTEM_PORTLET_PACKAGE
           
 
Method Summary
 java.lang.Long createPortalPageConfiguration(com.opensymphony.user.User u, java.lang.String pagename, java.lang.String description)
           
 java.lang.Long createPortalPageConfiguration(com.opensymphony.user.User u, java.lang.String pagename, java.lang.String description, java.lang.Long copyPageId)
           
 void decreasePageConfigurationSequence(com.opensymphony.user.User user, int position)
           
 void deletePortalPageConfiguration(com.opensymphony.user.User u, java.lang.Long pageId)
          This function removed a portal page configuration for a user including all of its portlet configurations and there properties
 java.util.Collection getAllPortlets()
           
 PortalPageConfiguration getDefaultPortalPage()
          Returns the default portal page configuration
 PortalPageConfiguration getEditablePortalPageConfiguration(com.opensymphony.user.User user, java.lang.Long pageId)
           
 PortalPageConfiguration getPortalPageConfiguration(com.opensymphony.user.User u, java.lang.Long pageId)
           
 java.util.Map getPortalPageConfigurations(com.opensymphony.user.User remoteUser)
          Get all the portal pages for a given user.
 Portlet getPortlet(java.lang.String id)
           
 java.util.Collection getPortlets(com.opensymphony.user.User user)
          This function returns all the portlets a user has permission to see.
 void increasePageConfigurationSequence(com.opensymphony.user.User remoteUser, int position)
          Increases the position of the page configuration ofr the user's page configuration set
 boolean isDefaultPortalPageName(java.lang.String pageName)
           
 boolean isMultiplePortalPagesEnabled()
           
 boolean isUsingDefaultPortalPageConfigurations(com.opensymphony.user.User remoteUser)
           
 void movePortlets(java.lang.Long[] selectedPortlets, PortalPageConfiguration sourcePage, PortalPageConfiguration destinationPage)
          Move portlets from one page to another
 void moveToEndPageConfigurationSequence(com.opensymphony.user.User user, int position)
           
 void moveToStartPageConfigurationSequence(com.opensymphony.user.User user, int position)
           
 void resetDefault(java.lang.String pagename)
          This function reloads the default portal page configuration from the database.
 

Field Detail

SYSTEM_PORTLET_PACKAGE

public static final java.lang.String SYSTEM_PORTLET_PACKAGE
See Also:
Constant Field Values

DASHBOARD_PAGE_NAME

public static final java.lang.String DASHBOARD_PAGE_NAME
See Also:
Constant Field Values
Method Detail

getPortlet

public Portlet getPortlet(java.lang.String id)

getAllPortlets

public java.util.Collection getAllPortlets()

createPortalPageConfiguration

public java.lang.Long createPortalPageConfiguration(com.opensymphony.user.User u,
                                                    java.lang.String pagename,
                                                    java.lang.String description)
                                             throws PortletConfigurationException
Throws:
PortletConfigurationException

createPortalPageConfiguration

public java.lang.Long createPortalPageConfiguration(com.opensymphony.user.User u,
                                                    java.lang.String pagename,
                                                    java.lang.String description,
                                                    java.lang.Long copyPageId)
                                             throws PortletConfigurationException
Throws:
PortletConfigurationException

getPortalPageConfiguration

public PortalPageConfiguration getPortalPageConfiguration(com.opensymphony.user.User u,
                                                          java.lang.Long pageId)
                                                   throws PortletConfigurationException
Throws:
PortletConfigurationException

getDefaultPortalPage

public PortalPageConfiguration getDefaultPortalPage()
                                             throws PortletConfigurationException
Returns the default portal page configuration

Returns:
Throws:
PortletConfigurationException

deletePortalPageConfiguration

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

Parameters:
u - Owner
pageId - id of portalpage
Throws:
PortletConfigurationException

getPortlets

public java.util.Collection getPortlets(com.opensymphony.user.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(com.opensymphony.user.User user,
                                                                  java.lang.Long pageId)
                                                           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.

getPortalPageConfigurations

public java.util.Map getPortalPageConfigurations(com.opensymphony.user.User remoteUser)
                                          throws PortletConfigurationException
Get all the portal pages for a given user.

Throws:
PortletConfigurationException

movePortlets

public void movePortlets(java.lang.Long[] selectedPortlets,
                         PortalPageConfiguration sourcePage,
                         PortalPageConfiguration destinationPage)
                  throws PortletConfigurationException,
                         org.ofbiz.core.entity.GenericEntityException
Move portlets from one page to another

Throws:
PortletConfigurationException
org.ofbiz.core.entity.GenericEntityException

isUsingDefaultPortalPageConfigurations

public boolean isUsingDefaultPortalPageConfigurations(com.opensymphony.user.User remoteUser)

isMultiplePortalPagesEnabled

public boolean isMultiplePortalPagesEnabled()

increasePageConfigurationSequence

public void increasePageConfigurationSequence(com.opensymphony.user.User remoteUser,
                                              int position)
                                       throws PortletConfigurationException
Increases the position of the page configuration ofr the user's page configuration set

Parameters:
remoteUser -
position - the current position of the portal page configuration to move
Throws:
PortletConfigurationException

decreasePageConfigurationSequence

public void decreasePageConfigurationSequence(com.opensymphony.user.User user,
                                              int position)
                                       throws PortletConfigurationException
Throws:
PortletConfigurationException

moveToStartPageConfigurationSequence

public void moveToStartPageConfigurationSequence(com.opensymphony.user.User user,
                                                 int position)
                                          throws PortletConfigurationException
Throws:
PortletConfigurationException

moveToEndPageConfigurationSequence

public void moveToEndPageConfigurationSequence(com.opensymphony.user.User user,
                                               int position)
                                        throws PortletConfigurationException
Throws:
PortletConfigurationException

isDefaultPortalPageName

public boolean isDefaultPortalPageName(java.lang.String pageName)


Copyright © 2002-2005 Atlassian. All Rights Reserved.