|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.portal.DefaultPortalManager
public class DefaultPortalManager
The portal manager for Standard Edition.
Field Summary |
---|
Fields inherited from interface com.atlassian.jira.portal.PortalManager |
---|
DASHBOARD_PAGE_NAME, SYSTEM_PORTLET_PACKAGE |
Constructor Summary | |
---|---|
DefaultPortalManager(PortletAccessManager portletAccessManager,
PortalPageService portalPageService,
FavouritesManager favouritesManager)
|
Method Summary | |
---|---|
Long |
createPortalPageConfiguration(User user,
String pagename,
String description)
Deprecated. Create a new portal page in JIRA. |
Long |
createPortalPageConfiguration(User u,
String pagename,
String description,
Long copyPageId)
Deprecated. Create a new portal page in JIRA by copying one already in the system. |
void |
decreasePageConfigurationSequence(User user,
int position)
Deprecated. Decreases the position of the page in the user's favourite page list. |
void |
deletePortalPageConfiguration(User u,
Long pageId)
Deprecated. This function removes a portal page configuration for a user including all of its portlet configurations and their properties. |
Collection |
getAllPortlets()
Deprecated. Return all the portlets on the system. |
PortalPageConfiguration |
getDefaultPortalPage()
Deprecated. Get the configuration for the default portal page. |
PortalPageConfiguration |
getEditablePortalPageConfiguration(User user,
Long pageId)
Deprecated. Get a PortalPageConfiguration from the database that the passed user can edit. |
PortalPageConfiguration |
getPortalPageConfiguration(User user,
Long pageId)
Deprecated. Get a portal page configuration from the database. |
Map |
getPortalPageConfigurations(User user)
Deprecated. Get all the portal pages that the passed user should see. |
Portlet |
getPortlet(String portletKey)
Deprecated. Return portlet identified by the passed portlet key. |
Collection |
getPortlets(User user)
Deprecated. This function returns all the portlets a user has permission to see. |
boolean |
hasAccessToPage(User u,
Long selectPageId)
Deprecated. Return true only if the given User has permission to view the PortalPage with the id selectPageId. |
void |
increasePageConfigurationSequence(User user,
int position)
Deprecated. Increases the position of the page in the user's favourite page list. |
boolean |
isDefaultPortalPageName(String pageName)
Deprecated. This method always returns false. |
boolean |
isMultiplePortalPagesEnabled()
Returns true if the user is allowed to create multiple PortalPage objects. |
boolean |
isUsingDefaultPortalPageConfigurations(User remoteUser)
Deprecated. Returns true only if the passed user has no portal owned portal pages. |
void |
movePortlets(Long[] selectedPortlets,
PortalPageConfiguration sourceConfig,
PortalPageConfiguration destinationConfig)
Deprecated. Move passed portlets portlets from one page to another. |
void |
moveToEndPageConfigurationSequence(User user,
int position)
Deprecated. Moves the page at the given position to the end of the user's favourite page list. |
void |
moveToStartPageConfigurationSequence(User user,
int position)
Deprecated. Moves the page at the given position to the start of the user's favourite page list. |
void |
resetDefault(String pagename)
Deprecated. This function reloads the default portal page configuration from the database. |
void |
updatePortalPage(User user,
Long pageId,
String name,
String description)
Deprecated. Updates the page with given name and description and persists it. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultPortalManager(PortletAccessManager portletAccessManager, PortalPageService portalPageService, FavouritesManager favouritesManager)
Method Detail |
---|
public boolean isMultiplePortalPagesEnabled()
PortalManager
public Collection getAllPortlets()
PortalManager
getAllPortlets
in interface PortalManager
public Collection getPortlets(User user)
PortalManager
getPortlets
in interface PortalManager
user
- requesting portlets
public Long createPortalPageConfiguration(User user, String pagename, String description) throws PortletConfigurationException
PortalManager
createPortalPageConfiguration
in interface PortalManager
user
- the user creating the page.pagename
- the name of the page.description
- the description for the page.
PortletConfigurationException
- when an error occurs during page creation.public Long createPortalPageConfiguration(User u, String pagename, String description, Long copyPageId) throws PortletConfigurationException
PortalManager
createPortalPageConfiguration
in interface PortalManager
u
- the user creating the page.pagename
- the name of the page.description
- the description for the page.copyPageId
- the id of the page to copy.
PortletConfigurationException
- when an error occurs during page creation.public PortalPageConfiguration getPortalPageConfiguration(User user, Long pageId) throws PortletConfigurationException
PortalManager
getPortalPageConfiguration
in interface PortalManager
user
- the user.pageId
- id of portal page to return. Passing null will return the system default dashboard.
PortletConfigurationException
- if an error occurs while retrieving the portal page.public PortalPageConfiguration getEditablePortalPageConfiguration(User user, Long pageId) throws PortletConfigurationException
PortalManager
getEditablePortalPageConfiguration
in interface PortalManager
user
- the user who needs the editable page configuration.pageId
- the identifier of the portal page. Can be set to null to make a copy of the system default dashboard.
PortletConfigurationException
- if an error occurs while looking for the portal page.public void resetDefault(String pagename)
PortalManager
resetDefault
in interface PortalManager
pagename
- is always ignored.public Map getPortalPageConfigurations(User user) throws PortletConfigurationException
PortalManager
getPortalPageConfigurations
in interface PortalManager
user
- the user to query for. A null user will return a map with the system dashboard.
PortletConfigurationException
- when an error occurspublic void movePortlets(Long[] selectedPortlets, PortalPageConfiguration sourceConfig, PortalPageConfiguration destinationConfig) throws PortletConfigurationException
PortalManager
movePortlets
in interface PortalManager
selectedPortlets
- the portlets of the source page to move.sourceConfig
- the page to move the portlets from.destinationConfig
- the page to move the portlets onto.
PortletConfigurationException
- if an error occurs while moving the portlets.public boolean isUsingDefaultPortalPageConfigurations(User remoteUser)
PortalManager
isUsingDefaultPortalPageConfigurations
in interface PortalManager
remoteUser
- the user to check.
public void increasePageConfigurationSequence(User user, int position) throws PortletConfigurationException
PortalManager
increasePageConfigurationSequence
in interface PortalManager
user
- the user performing the operation.position
- the current position of the page to re-sequence.
PortletConfigurationException
- if an error occurs while trying to re-order the page.public void decreasePageConfigurationSequence(User user, int position) throws PortletConfigurationException
PortalManager
decreasePageConfigurationSequence
in interface PortalManager
user
- the user.position
- the current position of the page to re-sequence.
PortletConfigurationException
- if an error occurs while trying to re-order the page.public void moveToStartPageConfigurationSequence(User user, int position) throws PortletConfigurationException
PortalManager
moveToStartPageConfigurationSequence
in interface PortalManager
user
- the user.position
- the current position of the page to re-sequence.
PortletConfigurationException
- if an error occurs while trying to re-order the page.public void moveToEndPageConfigurationSequence(User user, int position) throws PortletConfigurationException
PortalManager
moveToEndPageConfigurationSequence
in interface PortalManager
user
- the user performing the operation.position
- the current position of the page to resequence.
PortletConfigurationException
- if an error occurs while trying to re-order the page.public PortalPageConfiguration getDefaultPortalPage() throws PortletConfigurationException
PortalManager
PortalManager.getPortalPageConfiguration(User, Long)
.
getDefaultPortalPage
in interface PortalManager
PortletConfigurationException
- if an error occurs while retrieving the page.public void deletePortalPageConfiguration(User u, Long pageId) throws PortletConfigurationException
PortalManager
deletePortalPageConfiguration
in interface PortalManager
u
- the user.pageId
- id of portal page to remove.
PortletConfigurationException
- if an error occurs while deleting the page.public void updatePortalPage(User user, Long pageId, String name, String description)
PortalManager
updatePortalPage
in interface PortalManager
user
- currently logged in userpageId
- page idname
- page namedescription
- page descriptionpublic Portlet getPortlet(String portletKey)
PortalManager
getPortlet
in interface PortalManager
portletKey
- the plugin key of the portlet to return.
public boolean isDefaultPortalPageName(String pageName)
PortalManager
isDefaultPortalPageName
in interface PortalManager
pageName
- the page name to check
public boolean hasAccessToPage(User u, Long selectPageId)
PortalManager
hasAccessToPage
in interface PortalManager
u
- the user.selectPageId
- the id of the page.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |