com.atlassian.jira.issue.customfields
Interface CustomFieldSearcher

All Superinterfaces:
IssueSearcher<CustomField>
All Known Implementing Classes:
AbstractDateRangeSearcher, CascadingSelectSearcher, CustomFieldLabelsSearcher, DateRangeSearcher, DateTimeRangeSearcher, ExactNumberSearcher, ExactTextSearcher, GroupPickerSearcher, MultiSelectSearcher, NumberRangeSearcher, ProjectSearcher, SelectSearcher, TextSearcher, UserPickerGroupSearcher, UserPickerSearcher, VersionSearcher

public interface CustomFieldSearcher
extends IssueSearcher<CustomField>

The custom field searcher interface defines an IssueSearcher that's usable by CustomField objects. Since JIRA 4.0, searchers have changed a lot with the introduction of JQL. For examples of usage you might want to check out AbstractInitializationCustomFieldSearcher and its inheritors.

Since:
JIRA 3.0

Field Summary
 
Fields inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher
log
 
Method Summary
 CustomFieldSearcherClauseHandler getCustomFieldSearcherClauseHandler()
          Provides an object that can be used to handle the clauses that this searcher generates.
 CustomFieldSearcherModuleDescriptor getDescriptor()
           
 void init(CustomFieldSearcherModuleDescriptor customFieldSearcherModuleDescriptor)
          Initializes the searcher.
 
Methods inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher
getSearchInformation, getSearchInputTransformer, getSearchRenderer, init
 

Method Detail

init

void init(CustomFieldSearcherModuleDescriptor customFieldSearcherModuleDescriptor)
Initializes the searcher. This is called the first time this searcher is retrieved from the plugin manager. You can expect that JIRA will be initialized when this method is invoked.

Parameters:
customFieldSearcherModuleDescriptor - the module desriptor that defines this searcher.

getDescriptor

CustomFieldSearcherModuleDescriptor getDescriptor()
Returns:
the module descriptor that defined this searcher.

getCustomFieldSearcherClauseHandler

CustomFieldSearcherClauseHandler getCustomFieldSearcherClauseHandler()
Provides an object that can be used to handle the clauses that this searcher generates.

Returns:
an object that can be used to handle the clauses that this searcher generates, can be null.


Copyright © 2002-2010 Atlassian. All Rights Reserved.