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

java.lang.Object
  extended by com.atlassian.jira.web.action.util.sharing.SharedEntitySearchViewHelper
      extended by com.atlassian.jira.web.action.filter.FilterViewHelper

public class FilterViewHelper
extends SharedEntitySearchViewHelper

A class to help with implementing searching of Filters.

Since:
v3.13

Nested Class Summary
 
Nested classes/interfaces inherited from class com.atlassian.jira.web.action.util.sharing.SharedEntitySearchViewHelper
SharedEntitySearchViewHelper.SearchResult, SharedEntitySearchViewHelper.SortColumn
 
Constructor Summary
FilterViewHelper(ShareTypeFactory shareTypeFactory, JiraAuthenticationContext authCtx, String applicationContext, String actionUrlPrefix, SearchRequestService searchRequestService)
           
 
Method Summary
protected  SharedEntitySearchResult doExecuteSearch(JiraServiceContext ctx, SharedEntitySearchParameters searchParameters, int pageOffset, int pageWidth)
          Execute the search for the passed parameters.
protected  boolean validateSearchParameters(JiraServiceContext ctx, SharedEntitySearchParameters searchParameters, int pageOffset, int pageWidth)
          Ensure that it is possible to execute a search with the passed parameters.
 
Methods inherited from class com.atlassian.jira.web.action.util.sharing.SharedEntitySearchViewHelper
addParameter, createBasicUrlSearchParams, generateSortCssClass, generateSortIcon, generateSortUrl, getGroupShare, getPagingOffset, getPopularFilters, getProjectShare, getRoleShare, getSearchName, getSearchOwnerUserName, getSearchShareType, getSearchShareTypeJSON, getShareTypeRendererBeans, getSortColumn, isSortAscending, search, setGroupShare, setPagingOffset, setProjectShare, setRoleShare, setSearchName, setSearchOwnerUserName, setSearchShareType, setSortAscending, setSortColumn
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterViewHelper

public FilterViewHelper(ShareTypeFactory shareTypeFactory,
                        JiraAuthenticationContext authCtx,
                        String applicationContext,
                        String actionUrlPrefix,
                        SearchRequestService searchRequestService)
Method Detail

doExecuteSearch

protected SharedEntitySearchResult doExecuteSearch(JiraServiceContext ctx,
                                                   SharedEntitySearchParameters searchParameters,
                                                   int pageOffset,
                                                   int pageWidth)
Description copied from class: SharedEntitySearchViewHelper
Execute the search for the passed parameters.

Specified by:
doExecuteSearch in class SharedEntitySearchViewHelper
Parameters:
ctx - the context to execute the search under.
searchParameters - the parameters for the search.
pageOffset - the offset of the search result page to return.
pageWidth - the width of a search result page.
Returns:
the result of the search or null if an error occurred.

validateSearchParameters

protected boolean validateSearchParameters(JiraServiceContext ctx,
                                           SharedEntitySearchParameters searchParameters,
                                           int pageOffset,
                                           int pageWidth)
Description copied from class: SharedEntitySearchViewHelper
Ensure that it is possible to execute a search with the passed parameters.

Specified by:
validateSearchParameters in class SharedEntitySearchViewHelper
Parameters:
ctx - the context to execute the search under.
searchParameters - the parameters for the search.
pageOffset - the offset of the search result page to return.
pageWidth - the width of a search result page.
Returns:
true iff the search can be performed.


Copyright © 2002-2008 Atlassian. All Rights Reserved.