com.atlassian.jira.web.action.filter
Class ManageFilters

java.lang.Object
  extended by webwork.action.ActionSupport
      extended by com.atlassian.jira.action.JiraActionSupport
          extended by com.atlassian.jira.web.action.JiraWebActionSupport
              extended by com.atlassian.jira.web.action.ProjectActionSupport
                  extended by com.atlassian.jira.web.action.IssueActionSupport
                      extended by com.atlassian.jira.web.action.issue.SearchDescriptionEnabledAction
                          extended by com.atlassian.jira.web.action.filter.ManageFilters
All Implemented Interfaces:
ErrorCollection, I18nHelper, FilterOperationsAction, SharedEntitySearchAction, DropDownModelProvider<SearchRequestDisplayBean>, AuthorizationSupport, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware
Direct Known Subclasses:
ViewSharedFilters

public class ManageFilters
extends SearchDescriptionEnabledAction
implements SharedEntitySearchAction, FilterOperationsAction, DropDownModelProvider<SearchRequestDisplayBean>

Action class for managing filters. Also used by delete filter.

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
protected  SearchRequestDisplayBean.Factory beanFactory
           
protected static String CONTENTONLY
           
 
Fields inherited from class com.atlassian.jira.web.action.issue.SearchDescriptionEnabledAction
fieldValuesHolder, issueSearcherManager, permissionManager
 
Fields inherited from class com.atlassian.jira.web.action.IssueActionSupport
attachmentManager
 
Fields inherited from class com.atlassian.jira.web.action.ProjectActionSupport
projectManager
 
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
ManageFilters(JiraAuthenticationContext authCtx, IssueSearcherManager issueSearcherManager, SearchRequestService searchRequestService, ShareTypeFactory shareTypeFactory, SearchRequestDisplayBean.Factory beanFactory, SearchService searchService, SearchSortUtil searchSortUtil, com.atlassian.plugin.webresource.WebResourceManager webResourceManager)
           
 
Method Summary
 boolean canShowFavourite()
          Can we display the favourite column? Determined by if there is a user in the current session.
protected  String doExecute()
           
 String doView()
           
protected  String executeSearchView()
          This action method handles the actual Searching for SharedEntitys in this case Search Requests.
 DropDownModel getDropDownModel(SearchRequestDisplayBean displayBean, int listIndex)
           
 int getEndPosition()
           
protected  FilterViewHelper getFilterHelper()
           
 FilterLinkRenderer getFilterLinkRenderer()
           
 List getFilters()
           
 FilterViewHelper getFiltersViewHelper()
           
 List<SearchRequestDisplayBean> getFiltersWithSubscriptions()
           
 int getFiltersWithSubscriptionsCount()
           
 String getFilterView()
           
 String getGroupShare()
           
 String getNextUrl()
           
 Long getPagingOffset()
           
 String getPreviousUrl()
           
 String getProjectShare()
           
 String getRoleShare()
           
 String getSearchEmptyMessageKey()
           
 String getSearchName()
           
 String getSearchOwnerUserName()
           
 String getSearchShareType()
           
 String getSortColumn()
           
 int getStartPosition()
           
 int getTotalResultCount()
           
 boolean isContentOnly()
           
 boolean isFirstTab(String tab)
           
 boolean isSearchContentOnly()
           
 boolean isSearchRequested()
           
 boolean isSortAscending()
           
 boolean isTabShowing(String tab)
           
 boolean isUserLoggedIn()
          Is there a user associated with the session.
 void setContentOnly(boolean contentOnly)
           
protected  void setFilters(List<SearchRequestDisplayBean> filters)
           
 void setFilterView(String filterView)
           
 void setGroupShare(String groupShare)
           
 void setPagingOffset(Long pagingOffset)
           
 void setProjectShare(String projectShare)
           
 void setRoleShare(String roleShare)
           
 void setSearchContentOnly(boolean searchContentOnly)
           
 void setSearchName(String searchName)
           
 void setSearchOwnerUserName(String searchOwnerUserName)
           
protected  void setSearchResults(SharedEntitySearchViewHelper.SearchResult<SearchRequest> searchResults)
           
 void setSearchShareType(String searchShareType)
           
 void setSortAscending(boolean sortAscending)
           
 void setSortColumn(String sortColumn)
           
protected  String toUrl(SearchRequestDisplayBean filter, String page, boolean includeReturnUrl)
           
 
Methods inherited from class com.atlassian.jira.web.action.issue.SearchDescriptionEnabledAction
createFilterOperationsBean, getActionParams, getFieldValuesHolder, getFilterOperationsBean, getSearchContext, getSearcherGroups, getSearchers, getSearcherViewHtml, getSearchRequestJqlString, getSearchSorts, isFilterFavourite, isFilterValid, isSearchRequestFitsNavigator, isShown, populateFieldValuesHolderFromQuery, validateSearchFilterIsSavedFilter
 
Methods inherited from class com.atlassian.jira.web.action.IssueActionSupport
addIssueToHistory, clearSelectedIssue, getAttachmentManager, getCurrentFailedLoginCount, getCurrentJQL, getCustomFieldManager, getDaysPerWeek, getEverLoggedIn, getHoursPerDay, getIssueManager, getLastFailedLogin, getLastLogin, getLoginCount, getPossibleVersions, getPossibleVersionsReleasedFirst, getPrettyDuration, getPreviousLogin, getSearchRequest, getSelectedIssueId, getSessionPagerFilterManager, getSessionSearchRequestManager, getSessionSearchRequestManagerFactory, getSessionSelectedIssueManager, getTotalFailedLoginCount, getUrlEncoded, getWorkflow, getWorkflowTransitionDescription, getWorkflowTransitionDisplayName, isCustomFieldHidden, isElevatedSecurityCheckRequired, isFieldHidden, isFieldHidden, isTimeTrackingEnabled, setSearchRequest, setSelectedIssueId, updateSearchRequest
 
Methods inherited from class com.atlassian.jira.web.action.ProjectActionSupport
getBrowsableProjects, getBrowseableProjects, getSelectedProjectId, setSelectedProject, setSelectedProject
 
Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport
addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addReason, addReasons, forceRedirect, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDescTranslation, getDmyDateFormatter, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getJiraContactHelper, getJiraServiceContext, getLanguage, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getTimeFormat, getUriValidator, getUserFullName, getUserManager, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, hasIssuePermission, hasPermission, hasProjectPermission, htmlEncode, insertContextPath, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isInlineDialogMode, isSystemAdministrator, isUserExists, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, urlEncode
 
Methods inherited from class com.atlassian.jira.action.JiraActionSupport
addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getComponentInstanceOfType, getDefaultResourceBundle, getDelegator, getI18nHelper, getKeysForPrefix, getLocale, getOfBizDelegator, getRemoteUser, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getUnescapedText, getUntransformedRawText, getUserPreferences, getWatcherManager, hasAnyErrors, isIndexing, isKeyDefined, removeKeyOrAddError
 
Methods inherited from class webwork.action.ActionSupport
addError, addErrorMessage, doDefault, doValidation, getCommandName, getErrorMessages, getErrors, 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.web.action.filter.FilterOperationsAction
getFilterOperationsBean, isFilterValid
 
Methods inherited from interface com.atlassian.jira.util.ErrorCollection
addError, addErrorMessage, addErrorMessages, addErrors, getErrorMessages, getErrors, hasAnyErrors, setErrorMessages
 
Methods inherited from interface webwork.action.CommandDriven
getCommandName, setCommand
 

Field Detail

CONTENTONLY

protected static final String CONTENTONLY
See Also:
Constant Field Values

beanFactory

protected final SearchRequestDisplayBean.Factory beanFactory
Constructor Detail

ManageFilters

public ManageFilters(JiraAuthenticationContext authCtx,
                     IssueSearcherManager issueSearcherManager,
                     SearchRequestService searchRequestService,
                     ShareTypeFactory shareTypeFactory,
                     SearchRequestDisplayBean.Factory beanFactory,
                     SearchService searchService,
                     SearchSortUtil searchSortUtil,
                     com.atlassian.plugin.webresource.WebResourceManager webResourceManager)
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)

getFilters

public List getFilters()

setFilters

protected void setFilters(List<SearchRequestDisplayBean> filters)

getNextUrl

public String getNextUrl()

getPreviousUrl

public String getPreviousUrl()

getStartPosition

public int getStartPosition()

getEndPosition

public int getEndPosition()

getTotalResultCount

public int getTotalResultCount()

getFiltersViewHelper

public FilterViewHelper getFiltersViewHelper()

setSearchResults

protected void setSearchResults(SharedEntitySearchViewHelper.SearchResult<SearchRequest> searchResults)

getDropDownModel

public DropDownModel getDropDownModel(SearchRequestDisplayBean displayBean,
                                      int listIndex)
Specified by:
getDropDownModel in interface DropDownModelProvider<SearchRequestDisplayBean>
Parameters:
displayBean - some domain object
listIndex - this parameter indicates the position in of the domain object in a list of domain objects. Often generated markup uses position in the list to generate ids and the like
Returns:
a drop down model based on the values in domainObject

toUrl

protected String toUrl(SearchRequestDisplayBean filter,
                       String page,
                       boolean includeReturnUrl)

canShowFavourite

public boolean canShowFavourite()
Can we display the favourite column? Determined by if there is a user in the current session.

Returns:
true if there is a logged in user, else false

isUserLoggedIn

public boolean isUserLoggedIn()
Is there a user associated with the session.

Returns:
true if a user is associated with the action or false otherwise.

isSearchRequested

public boolean isSearchRequested()

getSearchEmptyMessageKey

public String getSearchEmptyMessageKey()

isTabShowing

public boolean isTabShowing(String tab)

isFirstTab

public boolean isFirstTab(String tab)

doExecute

protected String doExecute()
Overrides:
doExecute in class webwork.action.ActionSupport

doView

public String doView()

setContentOnly

public void setContentOnly(boolean contentOnly)

isContentOnly

public boolean isContentOnly()

setSearchContentOnly

public void setSearchContentOnly(boolean searchContentOnly)

isSearchContentOnly

public boolean isSearchContentOnly()

getFiltersWithSubscriptions

public List<SearchRequestDisplayBean> getFiltersWithSubscriptions()

getFiltersWithSubscriptionsCount

public int getFiltersWithSubscriptionsCount()

executeSearchView

protected String executeSearchView()
This action method handles the actual Searching for SharedEntitys in this case Search Requests.

Returns:
the JSP view

getFilterLinkRenderer

public FilterLinkRenderer getFilterLinkRenderer()

getFilterHelper

protected FilterViewHelper getFilterHelper()


Copyright © 2002-2013 Atlassian. All Rights Reserved.