DefaultPortalPageService (Atlassian JIRA 5.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.atlassian.jira.bc.portal
Class DefaultPortalPageService

java.lang.Object
  com.atlassian.jira.bc.portal.DefaultPortalPageService

All Implemented Interfaces:: PortalPageService

public class DefaultPortalPageService
extends Object
implements PortalPageService
extends Object
implements PortalPageService

The base class for PortalPageService implementations

Since:: v3.13

Constructor Summary
`DefaultPortalPageService(PortalPageManager portalPageManager, ShareTypeValidatorUtils shareTypeValidatorUtils, FavouritesManager<PortalPage> favouritesManager, PermissionManager permissionManager, UserUtil userUtil)`

Method Summary
`protected boolean`	`checkSystemDefaultSharePermissions(JiraServiceContext serviceCtx, SharedEntity.SharePermissions sharePermissions)` Check that the passed permissions are valid for the System Dashboard.
`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, 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(com.atlassian.crowd.embedded.api.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.
`Collection<PortalPage>`	`getFavouritePortalPages(com.atlassian.crowd.embedded.api.User user)` Retrieve all `PortalPage`'s a user has favourited.
`Collection<PortalPage>`	`getNonPrivatePortalPages(com.atlassian.crowd.embedded.api.User user)` Get a user's non private `PortalPage`'s.
`Collection<PortalPage>`	`getOwnedPortalPages(com.atlassian.crowd.embedded.api.User user)` Retrieve all `PortalPage`'s a user owns/has created.
`PortalPage`	`getPortalPage(JiraServiceContext context, Long portalPageId)` Retrieve a given `PortalPage` by id.
`Collection<PortalPage>`	`getPortalPagesFavouritedByOthers(com.atlassian.crowd.embedded.api.User user)` Get `PortalPage`'s owned by a given user that have been favourited by at least one other user
`List<List<PortletConfiguration>>`	`getPortletConfigurations(JiraServiceContext serviceCtx, Long portalPageId)` Returns all portlet configurations for a particular dashboard in colums and rows.
`PortalPage`	`getSystemDefaultPortalPage()` This returns the System Default PortalPage as defined by the JIRA Administrators
`void`	`increasePortalPageSequence(JiraServiceContext serviceCtx, Long portalPageId)` Increases the position of the page configuration in the user's page configuration set
`boolean`	`isFavourite(com.atlassian.crowd.embedded.api.User user, PortalPage portalPage)` Is the passed PortalPage a favourite of the passed User.
`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.
`void`	`saveLegacyPortletConfiguration(JiraServiceContext serviceCtx, PortletConfiguration portletConfiguration)` Save a specific `PortletConfiguration` to a database store.
`SharedEntitySearchResult<PortalPage>`	`search(JiraServiceContext serviceCtx, SharedEntitySearchParameters searchParameters, int pagePosition, int pageWidth)` Search for the PortalPages that match the passed SearchParameters.
`PortalPage`	`updatePortalPage(JiraServiceContext serviceCtx, PortalPage portalPage, boolean isFavourite)` Updates the specified PortalPage in the database
`PortalPage`	`updatePortalPageUnconditionally(JiraServiceContext serviceCtx, com.atlassian.crowd.embedded.api.User user, PortalPage portalPage)` Updates the specified PortalPage in the database , no permission checks are applied, but the user must be an administrator
`void`	`validateForChangeOwner(JiraServiceContext serviceCtx, PortalPage page)` This will validate that the dashboard page can be changed to the new owbner.
`boolean`	`validateForChangePortalPageSequence(JiraServiceContext serviceCtx, Long portalPageId)` Called to validate that sequence of a PortalPage can be changed.
`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`	`validateForGetPortalPage(JiraServiceContext context, Long portalPageId)` Check if the user in the service context has permission to get the portal page with the id provided.
`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

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

DefaultPortalPageService

public DefaultPortalPageService(PortalPageManager portalPageManager,
                                ShareTypeValidatorUtils shareTypeValidatorUtils,
                                FavouritesManager<PortalPage> favouritesManager,
                                PermissionManager permissionManager,
                                UserUtil userUtil)

Method Detail