public class

PortalPageDisplayBean

extends Object
implements SharesListHelper
java.lang.Object
   ↳ com.atlassian.jira.web.action.util.PortalPageDisplayBean

Class Overview

Utility class for displaying a PortalPage. Does a lot of the calculations that need to be done.

Summary

Public Constructors
PortalPageDisplayBean(JiraAuthenticationContext authCtx, PortalPage portalPage, FavouritesService favouriteService, PermissionManager permissionManager, ShareTypeFactory shareTypeFactory, UserFormatManager userFormatManager)
Public Methods
boolean canEditColumns()
Is it possible to edit columns in this version of JIRA
boolean canShare()
Is it possible to share pages
Collection<SharePermission> getAllSharePermissions()
long getAlternateFavouriteCount()
How many times has this page been favourited altered by whether it will disabled or enabled
String getDescription()
Long getFavouriteCount()
How many times has this page been favourited
Long getId()
Return the ID of the entity that owns the shares.
String getName()
String getOwnerFullName()
String getOwnerUserName()
Collection<SharePermission> getSharePermissions()
Returns the share permissions associated with the entity.
String getShareView(SharePermission sharePermission)
Return HTML view of the current sharing status of the page.
String getSimpleDescription(SharePermission sharePermission)
Return a simple description of the passed in permission.
boolean isCurrentOwner()
boolean isFavourite()
Is this page a favourite of the current user
boolean isPrivate()
Is this privately shared?
boolean isSystemDashboard()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.web.action.util.sharing.SharesListHelper

Public Constructors

public PortalPageDisplayBean (JiraAuthenticationContext authCtx, PortalPage portalPage, FavouritesService favouriteService, PermissionManager permissionManager, ShareTypeFactory shareTypeFactory, UserFormatManager userFormatManager)

Public Methods

public boolean canEditColumns ()

Is it possible to edit columns in this version of JIRA

Returns
  • true if it is possible (it is an Enterprise or Professional instance), else false

public boolean canShare ()

Is it possible to share pages

Returns
  • true if it is Enterprise or Professional and the current user has the Share permission

public Collection<SharePermission> getAllSharePermissions ()

public long getAlternateFavouriteCount ()

How many times has this page been favourited altered by whether it will disabled or enabled

Returns
  • the count of favourites of this page altered by whether it will disabled or enabled

public String getDescription ()

public Long getFavouriteCount ()

How many times has this page been favourited

Returns
  • the count of favourites of this page

public Long getId ()

Return the ID of the entity that owns the shares. Needs to be unique on a page.

Returns
  • the ID of the entity that owns the shared. Needs to be unique on a page.

public String getName ()

public String getOwnerFullName ()

public String getOwnerUserName ()

public Collection<SharePermission> getSharePermissions ()

Returns the share permissions associated with the entity.

Returns
  • a collection of shares associated with the entity.

public String getShareView (SharePermission sharePermission)

Return HTML view of the current sharing status of the page.

Parameters
sharePermission the share permission to render.
Returns
  • html view of the current sharing state.

public String getSimpleDescription (SharePermission sharePermission)

Return a simple description of the passed in permission.

Parameters
sharePermission The permission to describe.
Returns
  • a simple description of the passed in permission.

public boolean isCurrentOwner ()

public boolean isFavourite ()

Is this page a favourite of the current user

Returns
  • true if the user has favourited this page, else false

public boolean isPrivate ()

Is this privately shared?

Returns
  • true if its has privacy set to Private, else false

public boolean isSystemDashboard ()