com.atlassian.jira.web.action.filter

Class FilterPickerPopup

java.lang.Object

webwork.action.ActionSupport

com.atlassian.jira.action.JiraActionSupport

com.atlassian.jira.web.action.JiraWebActionSupport

com.atlassian.jira.web.action.filter.FilterPickerPopup

All Implemented Interfaces:

ErrorCollection, I18nHelper, SharedEntitySearchAction, HttpServletVariables, AuthorizationSupport, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

public class FilterPickerPopup
extends JiraWebActionSupport
implements SharedEntitySearchAction

Action implementation for the Filter Picker popup.

Since:

v3.13

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

JiraWebActionSupport.MessageType

Nested classes/interfaces inherited from interface com.atlassian.jira.web.action.util.sharing.SharedEntitySearchAction

SharedEntitySearchAction.FieldNameMapper, SharedEntitySearchAction.QueryValidator

Nested classes/interfaces inherited from interface com.atlassian.jira.util.ErrorCollection

ErrorCollection.Reason

Nested classes/interfaces inherited from interface com.atlassian.jira.util.I18nHelper

I18nHelper.BeanFactory

Field Summary

Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

ISSUE_NOT_FOUND_RESULT, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters

Fields inherited from class com.atlassian.jira.action.JiraActionSupport

log

Fields inherited from class webwork.action.ActionSupport

command, errorMap, errorMessages

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
FilterPickerPopup(SearchRequestService searchRequestService, ShareTypeFactory shareTypeFactory, PermissionManager permissionManager, JiraAuthenticationContext authCtx, ProjectManager projectManager, SearchRequestDisplayBean.Factory beanFactory, ProjectDescriptionRenderer projectDescriptionRenderer)

Method Summary

Modifier and Type	Method and Description
protected String	doExecute()
Collection<ProjectCategory>	getCategories()
int	getEndPosition()
String	getField()
FilterLinkRenderer	getFilterLinkRenderer()
List	getFilters()
com.atlassian.jira.web.action.filter.FilterPickerPopup.FilterPickerPopupViewHelper	getFiltersViewHelper()
String	getFilterView()
String	getGroupShare()
String	getNextUrl()
Long	getPagingOffset()
String	getPreviousUrl()
String	getProjectShare()
Collection<Project>	getProjectsInCategory(ProjectCategory projectCategory) Returns the projects which are in the given category.
Collection<Project>	getProjectsInNoCategory() Returns the projects which are not in a category.
String	getRenderedProjectDescription(Project project)
String	getRoleShare()
String	getSearchEmptyMessageKey() Returns the key for a message to be used in the case when there are no search results.
String	getSearchName()
String	getSearchOwnerUserName()
String	getSearchShareType()
String	getSortColumn()
int	getStartPosition()
int	getTotalResultCount()
boolean	isSearchRequested()
boolean	isShowFilters()
boolean	isShowProjects()
boolean	isSortAscending()
boolean	isTabShowing(String tab)
boolean	projectsExist() Returns true if there is at least one project somewhere.
void	setField(String field)
void	setFilterView(String filterView)
void	setGroupShare(String groupShare)
void	setPagingOffset(Long pagingOffset)
void	setProjectShare(String projectShare)
void	setRoleShare(String roleShare)
void	setSearchName(String searchName)
void	setSearchOwnerUserName(String searchOwnerUserName)
void	setSearchShareType(String searchShareType)
void	setShowFilters(boolean showFilters)
void	setShowProjects(boolean showProjects)
void	setSortAscending(boolean sortAscending)
void	setSortColumn(String sortColumn)
boolean	showCategories() Determines whether or not the list of projects should be shown grouped by categories.

Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addMessageToResponse, addReason, addReasons, forceRedirect, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDescTranslation, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getJiraContactHelper, getJiraServiceContext, getLanguage, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getTimeFormat, getUriValidator, getUserFullName, getUserManager, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, hasGlobalPermission, hasGlobalPermission, hasIssuePermission, hasIssuePermission, hasIssuePermission, hasPermission, hasProjectPermission, hasProjectPermission, htmlEncode, insertContextPath, isInlineDialogMode, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, tagMauEventWithApplication, tagMauEventWithProject, urlEncode

Methods inherited from class com.atlassian.jira.action.JiraActionSupport

addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getComponentInstanceOfType, getDefaultResourceBundle, getI18nHelper, getKeysForPrefix, getLocale, getOfBizDelegator, getResourceBundle, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getUnescapedText, getUntransformedRawText, getUserPreferences, hasAnyErrors, isIndexing, isKeyDefined, removeKeyOrAddError

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doDefault, doValidation, getCommandName, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, validate

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.util.ErrorCollection

addError, addErrorMessage, addErrorMessages, addErrors, hasAnyErrors, setErrorMessages

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Constructor Detail

FilterPickerPopup

public FilterPickerPopup(SearchRequestService searchRequestService,
                         ShareTypeFactory shareTypeFactory,
                         PermissionManager permissionManager,
                         JiraAuthenticationContext authCtx,
                         ProjectManager projectManager,
                         SearchRequestDisplayBean.Factory beanFactory,
                         ProjectDescriptionRenderer projectDescriptionRenderer)

Method Detail

getSearchName

public String getSearchName()

Specified by:

getSearchName in interface SharedEntitySearchAction

setSearchName

public void setSearchName(String searchName)

Specified by:

setSearchName in interface SharedEntitySearchAction

getSearchOwnerUserName

public String getSearchOwnerUserName()

Specified by:

getSearchOwnerUserName in interface SharedEntitySearchAction

setSearchOwnerUserName

public void setSearchOwnerUserName(String searchOwnerUserName)

Specified by:

setSearchOwnerUserName in interface SharedEntitySearchAction

getSearchShareType

public String getSearchShareType()

Specified by:

getSearchShareType in interface SharedEntitySearchAction

setSearchShareType

public void setSearchShareType(String searchShareType)

Specified by:

setSearchShareType in interface SharedEntitySearchAction

setGroupShare

public void setGroupShare(String groupShare)

Specified by:

setGroupShare in interface SharedEntitySearchAction

getGroupShare

public String getGroupShare()

Specified by:

getGroupShare in interface SharedEntitySearchAction

getPagingOffset

public Long getPagingOffset()

Specified by:

getPagingOffset in interface SharedEntitySearchAction

setProjectShare

public void setProjectShare(String projectShare)

Specified by:

setProjectShare in interface SharedEntitySearchAction

getProjectShare

public String getProjectShare()

Specified by:

getProjectShare in interface SharedEntitySearchAction

setRoleShare

public void setRoleShare(String roleShare)

Specified by:

setRoleShare in interface SharedEntitySearchAction

getRoleShare

public String getRoleShare()

Specified by:

getRoleShare in interface SharedEntitySearchAction

setPagingOffset

public void setPagingOffset(Long pagingOffset)

Specified by:

setPagingOffset in interface SharedEntitySearchAction

getSortColumn

public String getSortColumn()

Specified by:

getSortColumn in interface SharedEntitySearchAction

setSortColumn

public void setSortColumn(String sortColumn)

Specified by:

setSortColumn in interface SharedEntitySearchAction

isSortAscending

public boolean isSortAscending()

Specified by:

isSortAscending in interface SharedEntitySearchAction

setSortAscending

public void setSortAscending(boolean sortAscending)

Specified by:

setSortAscending in interface SharedEntitySearchAction

getFilterView

public String getFilterView()

setFilterView

public void setFilterView(String filterView)

isShowFilters

public boolean isShowFilters()

setShowFilters

public void setShowFilters(boolean showFilters)

isShowProjects

public boolean isShowProjects()

setShowProjects

public void setShowProjects(boolean showProjects)

getField

public String getField()

setField

public void setField(String field)

getFilters

public List getFilters()

isSearchRequested

public boolean isSearchRequested()

getNextUrl

public String getNextUrl()

getPreviousUrl

public String getPreviousUrl()

getStartPosition

public int getStartPosition()

getEndPosition

public int getEndPosition()

getTotalResultCount

public int getTotalResultCount()

getFiltersViewHelper

public com.atlassian.jira.web.action.filter.FilterPickerPopup.FilterPickerPopupViewHelper getFiltersViewHelper()

getSearchEmptyMessageKey

public String getSearchEmptyMessageKey()

Returns the key for a message to be used in the case when there are no search results. Either there was no search requested, the search failed or it returned no results.

Returns:

the key of the message to be rendered in the case where there is

isTabShowing

public boolean isTabShowing(String tab)

getFilterLinkRenderer

public FilterLinkRenderer getFilterLinkRenderer()

showCategories

public boolean showCategories()

Determines whether or not the list of projects should be shown grouped by categories. Standard edition doesn't have categories.

Returns:

true only if the front-end should display projects in categories.

getCategories

public Collection<ProjectCategory> getCategories()

doExecute

protected String doExecute()

Overrides:

doExecute in class webwork.action.ActionSupport

getProjectsInCategory

public Collection<Project> getProjectsInCategory(ProjectCategory projectCategory)

Returns the projects which are in the given category.

Parameters:

projectCategory - the category or null for those projects in no category.

Returns:

the projects.

getProjectsInNoCategory

public Collection<Project> getProjectsInNoCategory()

Returns the projects which are not in a category.

Returns:

the projects.

projectsExist

public boolean projectsExist()

Returns true if there is at least one project somewhere.

Returns:

true only if there is one or more projects in the system.

getRenderedProjectDescription

public String getRenderedProjectDescription(Project project)