com.atlassian.jira.web.action.util

Class SearchRequestDisplayBean

java.lang.Object

com.atlassian.jira.web.action.util.SearchRequestDisplayBean

All Implemented Interfaces:

SharesListHelper

public class SearchRequestDisplayBean
extends Object
implements SharesListHelper

Utility class for displaying a search request. Does a lot of the calculations that need to be done. E.g. is it a favourite, how many issues it contains, how many subscriptions.

Since:

v3.13

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchRequestDisplayBean.Factory

Constructor Summary

Constructors

Constructor and Description
SearchRequestDisplayBean(JiraAuthenticationContext authCtx, SearchRequest request, SearchProvider searchProvider, FavouritesService favouriteService, GlobalPermissionManager permissionManager, FilterSubscriptionService subscriptionService, ShareTypeFactory shareTypeFactory, UserFormats userFormats, ShareManager shareManager)

Method Summary

Modifier and Type	Method and Description
boolean	canEdit()
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 shared entity been favourited altered by by wether it will disabled or enabled
String	getDescription()
Long	getFavouriteCount() How many times has this shared entity been favourited
Long	getId()
long	getIssueCount() How many user visible issues does this filter match?
String	getName()
String	getOwnerFullName()
String	getOwnerUserName()
Collection<SharePermission>	getSharePermissions()
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.
long	getSubscriptionCount() How many subscriptions does this filter have? Only counts those subscriptions a user can see.
boolean	isCurrentOwner()
boolean	isFavourite() Is this shared entity a favourite of the current user
boolean	isPrivate() Is this shared entity privately shared?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.jira.web.action.util.sharing.SharesListHelper

getId, getSharePermissions, isPrivate

Constructor Detail

SearchRequestDisplayBean

public SearchRequestDisplayBean(JiraAuthenticationContext authCtx,
                                SearchRequest request,
                                SearchProvider searchProvider,
                                FavouritesService favouriteService,
                                GlobalPermissionManager permissionManager,
                                FilterSubscriptionService subscriptionService,
                                ShareTypeFactory shareTypeFactory,
                                UserFormats userFormats,
                                ShareManager shareManager)

Method Detail

getIssueCount

public long getIssueCount()

How many user visible issues does this filter match?

Returns:

the number of user visible issues that this filter matches

getSubscriptionCount

public long getSubscriptionCount()

How many subscriptions does this filter have? Only counts those subscriptions a user can see.

Returns:

The number of subscriptions for this filter

getId

public Long getId()

getOwnerUserName

public String getOwnerUserName()

getOwnerFullName

public String getOwnerFullName()

getName

public String getName()

isCurrentOwner

public boolean isCurrentOwner()

canEdit

public boolean canEdit()

getDescription

public String getDescription()

isPrivate

public boolean isPrivate()

Is this shared entity privately shared?

Returns:

true if the shared entity has privacy set to Private, else false

isFavourite

public boolean isFavourite()

Is this shared entity a favourite of the current user

Returns:

true if the user has favourited this shared entity, else false

getFavouriteCount

public Long getFavouriteCount()

How many times has this shared entity been favourited

Returns:

the count of favourites of this issue

getAlternateFavouriteCount

public long getAlternateFavouriteCount()

How many times has this shared entity been favourited altered by by wether it will disabled or enabled

Returns:

the count of favourites of this issue ltered by by wether it will disabled or enabled

canShare

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

canEditColumns

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

getSharePermissions

public Collection<SharePermission> getSharePermissions()

getAllSharePermissions

public Collection<SharePermission> getAllSharePermissions()

getShareView

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.

getSimpleDescription

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.