com.atlassian.jira.bc.portal
Interface PortalPageService

All Known Implementing Classes:

AbstractPortalPageService, ProfessionalPortalPageService, StandardPortalPageSevice

public interface PortalPageService

The PortalPageService is the top level service for Dashboard operations.

For historical reasons, Dashboards where called Portals and hence the prefix "Portal" is used consistently throughout the code.

Since:

v3.13

Method Summary

PortletConfiguration	addPortalPagePortletConfiguration(JiraServiceContext serviceCtx, PortalPage portalPage, String portletKey, int suggestedColumn, int suggestedRow) Adds a Portlet to the PortalPage and returns the [@link PortletConfiguration} that represents the newly added configuration.
boolean	canUserSeePortlet(User user, Portlet portlet) Returns true if the user is able to view the passed portlet.
boolean	canUserSeePortlet(User user, String portletKey) Returns true if the user is able to view the Portlet identified by portletKey.
PortalPage	copyPortletConfigurationInPortalPage(JiraServiceContext serviceCtx, PortalPage portalPage, Long portletConfigId) Make a new copy of a PortletConfiguration on a PortalPage.
PortalPage	createPortalPage(JiraServiceContext serviceCtx, PortalPage portalPage) Called to create and store the specified portalPage into the database.
PortalPage	createPortalPage(JiraServiceContext serviceCtx, PortalPage portalPage, boolean isFavourite) Called to create and store the specified portalPage into the database.
PortalPage	createPortalPageByClone(JiraServiceContext serviceCtx, PortalPage portalPage, Long clonePortalPageId) Called to create and store the specified portalPage into the database by cloning its Portlet content from an existing PortalPage object.
PortalPage	createPortalPageByClone(JiraServiceContext serviceCtx, PortalPage portalPage, Long clonePortalPageId, boolean isFavourite) Called to create and store the specified portalPage into the database by cloning its Portlet content from an existing PortalPage object.
void	decreasePortalPageSequence(JiraServiceContext serviceCtx, Long portalPageId) Decreases the position of the page configuration in the user's page configuration set.
void	deleteAllPortalPagesForUser(User user) Delete all Portal Pages owned by a user.
void	deletePortalPage(JiraServiceContext serviceCtx, Long portalPageId) Called to delete the PortalPage with the specified portalPageId.
PortalPage	deletePortalPagePortletConfiguration(JiraServiceContext serviceCtx, PortalPage portalPage, Long portletConfigId) This can be called to delete a specific PortletConfiguration object by id inside a PortalPage object from the underlying database store.
Collection	getFavouritePortalPages(User user) Retrieve all PortalPage's a user has favourited.
Collection	getNonPrivatePortalPages(User user) Get a user's non private PortalPage's.
Collection	getOwnedPortalPages(User user) Retrieve all PortalPage's a user owns/has created.
PortalPage	getPortalPage(JiraServiceContext servceCtx, Long portalPageId) Retrieve a given PortalPage by id.
Collection	getPortalPagesFavouritedByOthers(User user) Get PortalPage's owned by a given user that have been favourited by at least one other user
PortalPage	getSystemDefaultPortalPage() This returns the System Default PortalPage as defined by the JIRA Administrators
Portlet	getVisiblePortlet(JiraServiceContext serviceCtx, String portletKey) This returns a Portlet if the user can see it
Collection	getVisiblePortlets(JiraServiceContext serviceCtx) This returns a collections of the all the Portlet's a user can see
void	increasePortalPageSequence(JiraServiceContext serviceCtx, Long portalPageId) Increases the position of the page configuration in the user's page configuration set
boolean	isFavourite(User user, PortalPage portalPage) Is the passed PortalPage a favourite of the passed User.
boolean	isMultiplePortalPagesEnabled() This returns TRUE if the user is allowed to create multiple PortalPage objects.
PortalPage	movePortletConfigurationToPortalPage(JiraServiceContext serviceCtx, PortalPage srcPortalPage, PortalPage targetPortalPage, Long portletConfigId) Move a PortletConfiguration from one PortalPage to another.
void	moveToEndPortalPageSequence(JiraServiceContext serviceCtx, Long portalPageId) Puts the given page to the end of the user's page configuration set.
void	moveToStartPortalPageSequence(JiraServiceContext serviceCtx, Long portalPageId) Puts the given page to the start of the user's page configuration set.
PortalPage	saveAllPortalPagePortletConfiguration(JiraServiceContext serviceCtx, PortalPage portalPage) This can be called to save the PortletConfiguration objects inside a PortalPage object to the underlying database store.
PortalPage	savePortalPagePortletConfiguration(JiraServiceContext serviceCtx, PortalPage portalPage, Long portletConfigId) Save a specific PortletConfiguration inside the passed PortalPage to a database store.
SharedEntitySearchResult	search(JiraServiceContext serviceCtx, SharedEntitySearchParameters searchParameters, int pagePosition, int pageWidth) Search for the PortalPages that match the passed SearchParameters.
PortalPage	updatePortalPage(JiraServiceContext serviceCtx, PortalPage portalPage) Updates the specified PortalPage in the database
PortalPage	updatePortalPage(JiraServiceContext serviceCtx, PortalPage portalPage, boolean isFavourite) Updates the specified PortalPage in the database
boolean	validateForAddPortalPagePortletConfiguration(JiraServiceContext serviceCtx, PortalPage portalPage, String portletKey, int suggestedColumn, int suggestedRow) Called to validate that a Portlet can be added to the PortalPage
boolean	validateForChangePortalPageSequence(JiraServiceContext serviceCtx, Long portalPageId) Called to validate that sequence of a PortalPage can be changed.
boolean	validateForCopyPortletConfigurationInPortalPage(JiraServiceContext serviceCtx, PortalPage portalPage, Long portletConfigId) Check that it is possible to copy the PortletConfiguration on the passed PortalPage.
boolean	validateForCreate(JiraServiceContext serviceCtx, PortalPage portalPage) Called to validate that the PortalPage object is in a valid state for creation.
boolean	validateForCreatePortalPageByClone(JiraServiceContext serviceCtx, PortalPage portalPage, Long clonePortalPageId) Called to validate that a new PortalPage can be created by cloning its Portlet content from an existing PortalPage object.
boolean	validateForDelete(JiraServiceContext serviceCtx, Long portalPageId) Called to validate that the specified portalPage with the portalPageId can be deleted.
boolean	validateForDeletePortalPagePortletConfiguration(JiraServiceContext serviceCtx, PortalPage portalPage, Long portletConfigId) Make sure that the user can delete identified PortletConfiguration object from the inside of the PortalPage.
boolean	validateForMovePortletConfigurationToPortalPage(JiraServiceContext serviceCtx, PortalPage srcPortalPage, PortalPage targetPortalPage, Long portletConfigId) Check that it is possible to move a PortletConfiguration from one PortalPage to another.
boolean	validateForSaveAllPortalPagePortletConfiguration(JiraServiceContext jiraServiceContext, PortalPage portalPage) Make sure that the user can save all the PortletConfiguration inside the PortalPage.
boolean	validateForSavePortalPagePortletConfiguration(JiraServiceContext jiraServiceContext, PortalPage portalPage, Long portletConfigId) Make sure that the user can save a specific PortletConfiguration inside the passed PortalPage.
void	validateForSearch(JiraServiceContext serviceCtx, SharedEntitySearchParameters searchParameters) This will validate that the input parameters are valid for a search that encompasses ANY share entity type.
boolean	validateForUpdate(JiraServiceContext serviceCtx, PortalPage portalPage) Called to validate that the PortalPage can be be updated

Method Detail

getPortalPage

PortalPage getPortalPage(JiraServiceContext servceCtx,
                         Long portalPageId)

Retrieve a given PortalPage by id.

Parameters:

servceCtx - JIRA Service context containing an error collection and user requesting (to run) the PortalPage. The PortalPage must exist and the user must be able to see PortalPage else an error will result.

portalPageId - The id of the PortalPage to retrieve. Id must not be null.

Returns:

The PortalPage as specified by the id, or null if none exists for the user.

getFavouritePortalPages

Collection getFavouritePortalPages(User user)

Retrieve all PortalPage's a user has favourited. Permission checks are done to ensure the user can see the PortalPage, as visibility may have been removed from underneath them.

Parameters:

user - The user who has favourite PortalPage's. Also to test visibility and with

Returns:

a Collection of PortalPage objects that represent PortalPage's the user has favourited.

isFavourite

boolean isFavourite(User user,
                    PortalPage portalPage)

Is the passed PortalPage a favourite of the passed User.

Parameters:

user - the user to check.

portalPage - the page to check.

Returns:

true if the PortalPage is a favourite of the passed User.

getOwnedPortalPages

Collection getOwnedPortalPages(User user)

Retrieve all PortalPage's a user owns/has created.

Parameters:

user - The user who created the PortalPage's.

Returns:

a Collection of PortalPage objects that represent PortalPage's the user has created.

getNonPrivatePortalPages

Collection getNonPrivatePortalPages(User user)

Get a user's non private PortalPage's. I.e. PortalPage's that other users can possibly see.

Parameters:

user - The author of the PortalPage's

Returns:

Collection of PortalPage objects that do not have private scope.

getPortalPagesFavouritedByOthers

Collection getPortalPagesFavouritedByOthers(User user)

Get PortalPage's owned by a given user that have been favourited by at least one other user

Parameters:

user - The author of the PortalPage's

Returns:

Collection of PortalPage objects owned by the given user and favourited by at least one other user

getSystemDefaultPortalPage

PortalPage getSystemDefaultPortalPage()

This returns the System Default PortalPage as defined by the JIRA Administrators

Returns:

the system default PortalPage

isMultiplePortalPagesEnabled

boolean isMultiplePortalPagesEnabled()

This returns TRUE if the user is allowed to create multiple PortalPage objects. This is locked down on STANDARD JIRA

Returns:

true if uses can created multiple portal pages or false if not.

validateForCreate

boolean validateForCreate(JiraServiceContext serviceCtx,
                          PortalPage portalPage)

Called to validate that the PortalPage object is in a valid state for creation. Call this before calling the create method .

Parameters:

serviceCtx - the JiraServiceContext in play

portalPage - the PortalPage object that is to be validated for create

Returns:

true if the PortalPage is valid or false. The ErrorCollection of the serviceCtx will have any errors in it.

createPortalPage

PortalPage createPortalPage(JiraServiceContext serviceCtx,
                            PortalPage portalPage)

Called to create and store the specified portalPage into the database.

Parameters:

serviceCtx - the JiraServiceContext in play

portalPage - the PortalPage object that is to be created

Returns:

a fully fledged PortalPage with the new Id in it.

createPortalPage

PortalPage createPortalPage(JiraServiceContext serviceCtx,
                            PortalPage portalPage,
                            boolean isFavourite)

Called to create and store the specified portalPage into the database.

Parameters:

serviceCtx - the JiraServiceContext in play

portalPage - the PortalPage object that is to be created

isFavourite - set to true if the PortalPage should be marked as a favourite

Returns:

a fully fledged PortalPage with the new Id in it.

validateForCreatePortalPageByClone

boolean validateForCreatePortalPageByClone(JiraServiceContext serviceCtx,
                                           PortalPage portalPage,
                                           Long clonePortalPageId)

Called to validate that a new PortalPage can be created by cloning its Portlet content from an existing PortalPage object.

Parameters:

serviceCtx - the JiraServiceContext in play

portalPage - the PortalPage object that is to be created

clonePortalPageId - the id of an existing PortalPage to clone

Returns:

true if the PortalPage can be cloned from another page

createPortalPageByClone

PortalPage createPortalPageByClone(JiraServiceContext serviceCtx,
                                   PortalPage portalPage,
                                   Long clonePortalPageId)

Called to create and store the specified portalPage into the database by cloning its Portlet content from an existing PortalPage object.

Parameters:

serviceCtx - the JiraServiceContext in play

portalPage - the PortalPage object that is to be created

clonePortalPageId - the id of an existing PortalPage to clone

Returns:

a fully fledged PortalPage with the new Id in it.

createPortalPageByClone

PortalPage createPortalPageByClone(JiraServiceContext serviceCtx,
                                   PortalPage portalPage,
                                   Long clonePortalPageId,
                                   boolean isFavourite)

Called to create and store the specified portalPage into the database by cloning its Portlet content from an existing PortalPage object.

Parameters:

serviceCtx - the JiraServiceContext in play

portalPage - the PortalPage object that is to be created

clonePortalPageId - the id of an existing PortalPage to clone

isFavourite - set to true if the PortalPage should be marked as a favourite

Returns:

a fully fledged PortalPage with the new Id in it.

validateForDelete

boolean validateForDelete(JiraServiceContext serviceCtx,
                          Long portalPageId)

Called to validate that the specified portalPage with the portalPageId can be deleted.

Parameters:

serviceCtx - the JiraServiceContext in play

portalPageId - the id of the PortalPage to delete

Returns:

true if the PortalPage can be deleted. The ErrorCollection of the serviceCtx will have any errors in it.

deletePortalPage

void deletePortalPage(JiraServiceContext serviceCtx,
                      Long portalPageId)

Called to delete the PortalPage with the specified portalPageId.

Parameters:

serviceCtx - the JiraServiceContext in play

portalPageId - the id of the PortalPage to delete

validateForUpdate

boolean validateForUpdate(JiraServiceContext serviceCtx,
                          PortalPage portalPage)

Called to validate that the PortalPage can be be updated

Parameters:

serviceCtx - the JiraServiceContext in play

portalPage - the PortalPage to update

Returns:

true if the PortalPage is valid or false. The ErrorCollection of the serviceCtx will have any errors in it.

updatePortalPage

PortalPage updatePortalPage(JiraServiceContext serviceCtx,
                            PortalPage portalPage)

Updates the specified PortalPage in the database

Parameters:

serviceCtx - the JiraServiceContext in play

portalPage - the PortalPage to update

Returns:

a newly updated PortalPage

updatePortalPage

PortalPage updatePortalPage(JiraServiceContext serviceCtx,
                            PortalPage portalPage,
                            boolean isFavourite)

Updates the specified PortalPage in the database

Parameters:

serviceCtx - the JiraServiceContext in play

portalPage - the PortalPage to update

isFavourite - set to true if the PortalPage is to be marked as a favourite

Returns:

a newly updated PortalPage

validateForChangePortalPageSequence

boolean validateForChangePortalPageSequence(JiraServiceContext serviceCtx,
                                            Long portalPageId)

Called to validate that sequence of a PortalPage can be changed.

Parameters:

serviceCtx - the context of the service call

portalPageId - the id of the PortalPage to re-sequence

Returns:

true if the PortalPage can be re-sequenced

increasePortalPageSequence

void increasePortalPageSequence(JiraServiceContext serviceCtx,
                                Long portalPageId)

Increases the position of the page configuration in the user's page configuration set

Parameters:

serviceCtx - the context of the service call

portalPageId - the id of the PortalPage to re-sequence

decreasePortalPageSequence

void decreasePortalPageSequence(JiraServiceContext serviceCtx,
                                Long portalPageId)

Decreases the position of the page configuration in the user's page configuration set.

Parameters:

serviceCtx - the context of the service call

portalPageId - the id of the PortalPage to re-sequence

moveToStartPortalPageSequence

void moveToStartPortalPageSequence(JiraServiceContext serviceCtx,
                                   Long portalPageId)

Puts the given page to the start of the user's page configuration set.

Parameters:

serviceCtx - the context of the service call

portalPageId - the id of the PortalPage to re-sequence

moveToEndPortalPageSequence

void moveToEndPortalPageSequence(JiraServiceContext serviceCtx,
                                 Long portalPageId)

Puts the given page to the end of the user's page configuration set.

Parameters:

serviceCtx - the context of the service call

portalPageId - the id of the PortalPage to re-sequence

validateForSaveAllPortalPagePortletConfiguration

boolean validateForSaveAllPortalPagePortletConfiguration(JiraServiceContext jiraServiceContext,
                                                         PortalPage portalPage)

Make sure that the user can save all the PortletConfiguration inside the PortalPage.

Parameters:

jiraServiceContext - the context of the service call

portalPage - the PortalPage in question

Returns:

true if the user can save the portlet or false otherwise.

saveAllPortalPagePortletConfiguration

PortalPage saveAllPortalPagePortletConfiguration(JiraServiceContext serviceCtx,
                                                 PortalPage portalPage)

This can be called to save the PortletConfiguration objects inside a PortalPage object to the underlying database store.

Parameters:

serviceCtx - the context of the service call

portalPage - the PortalPage in question

Returns:

a newly refreshed PortalPage object whose internals reflects what has been saved

validateForSavePortalPagePortletConfiguration

boolean validateForSavePortalPagePortletConfiguration(JiraServiceContext jiraServiceContext,
                                                      PortalPage portalPage,
                                                      Long portletConfigId)

Make sure that the user can save a specific PortletConfiguration inside the passed PortalPage.

Parameters:

jiraServiceContext - the context of the service call

portalPage - the PortalPage in question

portletConfigId - the id of the configuration that should be saved.

Returns:

true if the user can save the portlet or false otherwise.

savePortalPagePortletConfiguration

PortalPage savePortalPagePortletConfiguration(JiraServiceContext serviceCtx,
                                              PortalPage portalPage,
                                              Long portletConfigId)

Save a specific PortletConfiguration inside the passed PortalPage to a database store.

Parameters:

serviceCtx - the context of the service call

portalPage - the PortalPage in question

portletConfigId - the configuration to copy.

Returns:

a newly refreshed PortalPage object whose internals reflects what has been saved

validateForDeletePortalPagePortletConfiguration

boolean validateForDeletePortalPagePortletConfiguration(JiraServiceContext serviceCtx,
                                                        PortalPage portalPage,
                                                        Long portletConfigId)

Make sure that the user can delete identified PortletConfiguration object from the inside of the PortalPage.

Parameters:

serviceCtx - the context of the service call

portalPage - the PortalPage in question

portletConfigId - the id of the PortletConfiguration inside the PortalPage

Returns:

true if the user can delete the portlet or false otherwise.

deletePortalPagePortletConfiguration

PortalPage deletePortalPagePortletConfiguration(JiraServiceContext serviceCtx,
                                                PortalPage portalPage,
                                                Long portletConfigId)

This can be called to delete a specific PortletConfiguration object by id inside a PortalPage object from the underlying database store.

Parameters:

serviceCtx - the context of the service call

portalPage - the PortalPage in question

portletConfigId - the id of the PortletConfiguration inside the PortalPage

Returns:

a newly refreshed PortalPage object whose internals reflects what has been changed

validateForAddPortalPagePortletConfiguration

boolean validateForAddPortalPagePortletConfiguration(JiraServiceContext serviceCtx,
                                                     PortalPage portalPage,
                                                     String portletKey,
                                                     int suggestedColumn,
                                                     int suggestedRow)

Called to validate that a Portlet can be added to the PortalPage

Parameters:

serviceCtx - the context of the service call

portalPage - the PortalPage to add the Portlet to

portletKey - the key of the Portlet to add

suggestedColumn - the suggested column inside the PortalPage

suggestedRow - the suggested row inside the PortalPage

Returns:

true if the Portlet can be added

addPortalPagePortletConfiguration

PortletConfiguration addPortalPagePortletConfiguration(JiraServiceContext serviceCtx,
                                                       PortalPage portalPage,
                                                       String portletKey,
                                                       int suggestedColumn,
                                                       int suggestedRow)

Adds a Portlet to the PortalPage and returns the [@link PortletConfiguration} that represents the newly added configuration.

Parameters:

serviceCtx - the context of the service call

portalPage - the PortalPage to add the Portlet to

portletKey - the key of the Portlet to add

suggestedColumn - the suggested column inside the PortalPage

suggestedRow - the suggested row inside the PortalPage

Returns:

a PortletConfiguration representing where the Portlet was placed. The PortalPage may in fact renumber where the PP was placed.

validateForCopyPortletConfigurationInPortalPage

boolean validateForCopyPortletConfigurationInPortalPage(JiraServiceContext serviceCtx,
                                                        PortalPage portalPage,
                                                        Long portletConfigId)

Check that it is possible to copy the PortletConfiguration on the passed PortalPage.

Parameters:

serviceCtx - the context of the service call.

portalPage - the PortalPage that contains the PortletConfiguration to copy.

portletConfigId - the id of the PortletConfiguration to copy.

Returns:

true if the PortletConfiguration can be copied or false otherwise.

copyPortletConfigurationInPortalPage

PortalPage copyPortletConfigurationInPortalPage(JiraServiceContext serviceCtx,
                                                PortalPage portalPage,
                                                Long portletConfigId)

Make a new copy of a PortletConfiguration on a PortalPage.

Parameters:

serviceCtx - the context of the service call

portalPage - the PortalPage that contains the PortletConfiguration to copy.

portletConfigId - the id of the PortletConfiguration to copy. It must be attached to the passed PortalPage.

Returns:

the new PortalPage with the copied PortletConfiguration.

validateForMovePortletConfigurationToPortalPage

boolean validateForMovePortletConfigurationToPortalPage(JiraServiceContext serviceCtx,
                                                        PortalPage srcPortalPage,
                                                        PortalPage targetPortalPage,
                                                        Long portletConfigId)

Check that it is possible to move a PortletConfiguration from one PortalPage to another.

Parameters:

serviceCtx - the context of the service call.

srcPortalPage - the PortalPage that contains the PortletConfiguration to move.

targetPortalPage - the PortalPage to receive the PortletConfiguration.

portletConfigId - the id of the PortletConfiguration to move.

Returns:

true if the PortletConfiguration can be moved or false otherwise.

movePortletConfigurationToPortalPage

PortalPage movePortletConfigurationToPortalPage(JiraServiceContext serviceCtx,
                                                PortalPage srcPortalPage,
                                                PortalPage targetPortalPage,
                                                Long portletConfigId)

Move a PortletConfiguration from one PortalPage to another.

Parameters:

serviceCtx - the context of the service call.

srcPortalPage - the PortalPage that contains the PortletConfiguration to move.

targetPortalPage - the PortalPage to receive the PortletConfiguration.

portletConfigId - the id of the PortletConfiguration to move.

Returns:

the changed targetPortalPage or null if the call failed.

canUserSeePortlet

boolean canUserSeePortlet(User user,
                          String portletKey)

Returns true if the user is able to view the Portlet identified by portletKey.

Parameters:

user - the user to check.

portletKey - the plugin id of the portlet to test.

Returns:

true if the user is able to view the Portlet identified by portletKey.

canUserSeePortlet

boolean canUserSeePortlet(User user,
                          Portlet portlet)

Returns true if the user is able to view the passed portlet.

Parameters:

user - the user to check.

portlet - the portlet to test.

Returns:

true if the user is able to view the passed portlet.

getVisiblePortlets

Collection getVisiblePortlets(JiraServiceContext serviceCtx)

This returns a collections of the all the Portlet's a user can see

Parameters:

serviceCtx - the context of the service call

Returns:

a list of Portlet's the user can see

getVisiblePortlet

Portlet getVisiblePortlet(JiraServiceContext serviceCtx,
                          String portletKey)

This returns a Portlet if the user can see it

Parameters:

serviceCtx - the context of the service call

portletKey - the plugin id of the portlet to test.

Returns:

a Portlet if the user can see it

validateForSearch

void validateForSearch(JiraServiceContext serviceCtx,
                       SharedEntitySearchParameters searchParameters)

This will validate that the input parameters are valid for a search that encompasses ANY share entity type.

Parameters:

serviceCtx - Context containing user, error collection and i18n bean

searchParameters - the SharedEntitySearchParameters to validate

search

SharedEntitySearchResult search(JiraServiceContext serviceCtx,
                                SharedEntitySearchParameters searchParameters,
                                int pagePosition,
                                int pageWidth)

Search for the PortalPages that match the passed SearchParameters. The result can be paged so that a subset of the results can be returned.

Parameters:

serviceCtx - Context containing user, error collection and i18n bean

searchParameters - the searchParameters to query.

pagePosition - the page to return.

pageWidth - the number of results per page.

Returns:

the result of the search.

deleteAllPortalPagesForUser

void deleteAllPortalPagesForUser(User user)

Delete all Portal Pages owned by a user. This method will also remove all favourites for all portlets as well as remove all favourites for the user. A nice big cleanup method for when deleting a user.

Parameters:

user - The user to clean up after.