@PublicSpi
public interface SearchRenderer
SearchInputTransformer
to populate a SearchRequest.Modifier and Type | Method and Description |
---|---|
String |
getEditHtml(ApplicationUser user,
SearchContext searchContext,
FieldValuesHolder fieldValuesHolder,
Map<?,?> displayParameters,
webwork.action.Action action)
Used to produce an HTML input that is rendered on the JIRA issue navigator.
|
String |
getViewHtml(ApplicationUser user,
SearchContext searchContext,
FieldValuesHolder fieldValuesHolder,
Map<?,?> displayParameters,
webwork.action.Action action)
Used to produce the HTML that displays a searchers summary information (e.g.
|
boolean |
isRelevantForQuery(ApplicationUser user,
Query query)
Checks if the searchRequest object has a search representation that was created by the searcher and is
used to determine if the
#getViewHtml(User, com.atlassian.jira.issue.search.SearchContext, com.atlassian.jira.issue.transport.FieldValuesHolder, java.util.Map, webwork.action.Action)
method should be called when rendering the search summary. |
boolean |
isShown(ApplicationUser user,
SearchContext searchContext)
Checks if the searcher should be shown in this context on the Issue Navigator.
|
String getEditHtml(ApplicationUser user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map<?,?> displayParameters, webwork.action.Action action)
SearchInputTransformer
that will know how to transform these input parameters into JIRA search objects.user
- performing this action.searchContext
- the search context of the current search request that may be participating in rendering the
issue navigator.fieldValuesHolder
- contains any request parameters that the HTML input may need to use to pre-populate
the input (e.g. if this is the priority renderer and the search request being rendered has two priorities already
selected these params will contain these request parameters). These parameters will have been populated via a
call to com.atlassian.jira.issue.search.searchers.transformer.SearchInputTransformer#populateFromQuery(User, com.atlassian.jira.issue.transport.FieldValuesHolder, com.atlassian.query.Query, com.atlassian.jira.issue.search.SearchContext)
if there is a SearchRequest involved in the rendering this IssueNavigator call.displayParameters
- are a map of "hints" that can be passed from the caller to this code which can use these
hints to alter the way it renders the HTML.action
- is the WebWork 1 action object that is rendering the Issue Navigator view. This can be used to
invoke methods on the view.boolean isShown(ApplicationUser user, SearchContext searchContext)
user
- performing this action.searchContext
- the context of the search (i.e. projects and issue types selected).String getViewHtml(ApplicationUser user, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map<?,?> displayParameters, webwork.action.Action action)
user
- performing this action.searchContext
- the search context of the current search request that may be participating in rendering the
issue navigator.fieldValuesHolder
- contains any request parameters that the HTML input may need to use to pre-populate
the input (e.g. if this is the priority renderer and the search request being rendered has two priorities already
selected these params will contain these request parameters). These parameters will have been populated via a
call to com.atlassian.jira.issue.search.searchers.transformer.SearchInputTransformer#populateFromQuery(User, com.atlassian.jira.issue.transport.FieldValuesHolder, com.atlassian.query.Query, com.atlassian.jira.issue.search.SearchContext)
if there is a SearchRequest involved in the rendering this IssueNavigator call.displayParameters
- are a map of "hints" that can be passed from the caller to this code which can use these
hints to alter the way it renders the HTML.action
- is the WebWork 1 action object that is rendering the Issue Navigator view. This can be used to
invoke methods on the view.boolean isRelevantForQuery(ApplicationUser user, Query query)
#getViewHtml(User, com.atlassian.jira.issue.search.SearchContext, com.atlassian.jira.issue.transport.FieldValuesHolder, java.util.Map, webwork.action.Action)
method should be called when rendering the search summary.user
- performing this action.query
- contains the search criteria used to determine if this query is relevevant to the searcher.Copyright © 2002-2017 Atlassian. All Rights Reserved.