|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IssueSearcher
The interface defines an object responsible for all search related activities in the IssueNavigator
. The
interface operates similar to the Field
objects (e.g. OrderableField
. It is responsible for
populating itself from ActionParams
and SearchRequest
as well as all rendering related activities.
CustomField
searchers should still extend the sub-interface CustomFieldSearcher
.
Field Summary | |
---|---|
static String |
I18N_BUNDLE
|
static org.apache.log4j.Logger |
log
|
Method Summary | |
---|---|
String |
getEditHtml(SearchContext searchContext,
FieldValuesHolder fieldValuesHolder,
Map displayParameters,
webwork.action.Action action)
|
String |
getQuerySnippet(SearchRequest searchRequest)
Returns a JiraUrlCodec.encode(String) encoded string representing the relevent SearchParameter
in the searchRequest. |
List |
getRelatedIndexers()
Returns a list of FieldIndexer objects. |
String |
getViewHtml(SearchContext searchContext,
FieldValuesHolder fieldValuesHolder,
Map displayParameters,
webwork.action.Action action)
|
void |
init(SearchableField field)
Initialises the searcher with a given field. |
boolean |
isRevelentForSeachRequest(SearchRequest searchRequest)
Checks if the searchRequest object has SearchParameter objects that was created by the searcher |
boolean |
isShown(SearchContext searchContext)
Checks if the searcher should be shown in this context |
void |
populateFromParams(FieldValuesHolder fieldValuesHolder,
ActionParams actionParams)
Populate FieldValuesHolder object with whatever values the searcher is interested in from the ActionParams |
void |
populateFromSearchRequest(FieldValuesHolder fieldValuesHolder,
SearchRequest searchRequest)
Populate FieldValuesHolder from the SearchRequest object. |
void |
populateSearchRequest(SearchRequest searchRequest,
FieldValuesHolder fieldValuesHolder)
Populate the SearchRequest with SearchParameter objects from the FieldValuesHolder |
void |
register(SearcherRegistry registry)
Registers the searcher in the registry. |
void |
validateParams(SearchContext searchContext,
FieldValuesHolder fieldValuesHolder,
I18nHelper i18nHelper,
ErrorCollection errors)
Adds error meessages to the errors object if values in the fieldValuesHolder fails validation. |
Methods inherited from interface com.atlassian.jira.issue.fields.Field |
---|
getId, getName, getNameKey |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Field Detail |
---|
static final org.apache.log4j.Logger log
static final String I18N_BUNDLE
Method Detail |
---|
void register(SearcherRegistry registry)
registry
- The Searcher registryvoid init(SearchableField field)
field
- the field object. This may be null. (So you can have searchers on non-fields)List getRelatedIndexers()
FieldIndexer
objects. The objects should be initialised and ready for action
List
of FieldIndexer
objects. Must not be null. Return Collections.EMPTY_LIST
if not availablevoid validateParams(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, I18nHelper i18nHelper, ErrorCollection errors)
searchContext
- the context of the search (i.e. projects and issue types selected)fieldValuesHolder
- contains values populated by the searchersi18nHelper
- errors
- void populateFromParams(FieldValuesHolder fieldValuesHolder, ActionParams actionParams)
FieldValuesHolder
object with whatever values the searcher is interested in from the ActionParams
fieldValuesHolder
- contains values populated by the searchersactionParams
- params from the webwork front endvoid populateFromSearchRequest(FieldValuesHolder fieldValuesHolder, SearchRequest searchRequest)
FieldValuesHolder
from the SearchRequest
object. Which SearchParameter
really
to take from the SR should match with the method populateSearchRequest(SearchRequest, FieldValuesHolder)
fieldValuesHolder
- contains values populated by the searcherssearchRequest
- relevent search requestpopulateSearchRequest(SearchRequest, FieldValuesHolder)
void populateSearchRequest(SearchRequest searchRequest, FieldValuesHolder fieldValuesHolder)
SearchRequest
with SearchParameter
objects from the FieldValuesHolder
searchRequest
- relevent search requestfieldValuesHolder
- contains values populated by the searchersboolean isRevelentForSeachRequest(SearchRequest searchRequest)
SearchParameter
objects that was created by the searcher
searchRequest
- relevent search request
boolean isShown(SearchContext searchContext)
searchContext
- the context of the search (i.e. projects and issue types selected)
String getEditHtml(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action)
String getViewHtml(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action)
String getQuerySnippet(SearchRequest searchRequest)
JiraUrlCodec.encode(String)
encoded string representing the relevent SearchParameter
in the searchRequest. The queryString should be able to be converted back to the original SearchRequest. i.e.
getQuerySnippet -> String -> populateFromParams -> FieldValuesHolder -> populateSearchRequest -> SearchRequest ->
getQuerySnippet should return the same original string.
searchRequest
- relevent search request
JiraUrlCodec.encode(String)
encoded string representing the relevent SearchParameter
in the searchRequest
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |