com.atlassian.jira.issue.search.searchers
Interface IssueSearcher<T extends SearchableField>

All Known Subinterfaces:
CustomFieldSearcher
All Known Implementing Classes:
AbstractDateRangeSearcher, AbstractDateSearcher, AbstractInitializationCustomFieldSearcher, AbstractInitializationSearcher, AbstractRelativeDateSearcher, AffectedVersionsSearcher, AssigneeSearcher, CascadingSelectSearcher, CommentQuerySearcher, ComponentsSearcher, CreatedDateSearcher, CreatorSearcher, CustomFieldLabelsSearcher, DateRangeSearcher, DateTimeRangeSearcher, DescriptionQuerySearcher, DueDateSearcher, EnvironmentQuerySearcher, ExactNumberSearcher, ExactTextSearcher, FixForVersionsSearcher, GroupPickerSearcher, IssueTypeSearcher, LabelSearcher, LabelsSearcher, MockCustomFieldSearcher, MockIssueSearcher, MockSystemSearcher, MultiSelectSearcher, NumberRangeSearcher, PrioritySearcher, ProjectSearcher, ProjectSearcher, ReporterSearcher, ResolutionDateSearcher, ResolutionSearcher, SelectSearcher, StatusSearcher, SummaryQuerySearcher, TextQuerySearcher, TextSearcher, UpdatedDateSearcher, UserPickerGroupSearcher, UserPickerSearcher, VersionPickerSearcher, VersionSearcher, WorkRatioSearcher

@PublicApi
@PublicSpi
public interface IssueSearcher<T extends SearchableField>

The interface defines an object responsible for all search related activities in the Issue Navigator. 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.

Since:
JIRA 3.3

Field Summary
static org.apache.log4j.Logger log
           
 
Method Summary
 SearcherInformation<T> getSearchInformation()
          Provides an object that contains information about the Searcher.
 SearchInputTransformer getSearchInputTransformer()
          Provides an object that will allow you to transform raw request parameters to field holder values and field holder values to Clause search representations.
 SearchRenderer getSearchRenderer()
          Provides an object that will allow you to render the edit and view html for a searcher.
 void init(T field)
          Initialises the searcher with a given field.
 

Field Detail

log

static final org.apache.log4j.Logger log
Method Detail

init

void init(T field)
Initialises the searcher with a given field.

Parameters:
field - the field object. This may be null. (So you can have searchers on non-fields)

getSearchInformation

SearcherInformation<T> getSearchInformation()
Provides an object that contains information about the Searcher.

Returns:
the search information provider for this searcher.

getSearchInputTransformer

SearchInputTransformer getSearchInputTransformer()
Provides an object that will allow you to transform raw request parameters to field holder values and field holder values to Clause search representations.

Returns:
the search input handler for this searcher.

getSearchRenderer

SearchRenderer getSearchRenderer()
Provides an object that will allow you to render the edit and view html for a searcher. This also provides methods that indicate if the view and edit methods should be invoked.

Returns:
the search renderer for this searcher.


Copyright © 2002-2015 Atlassian. All Rights Reserved.