com.atlassian.jira.issue.customfields
Interface CustomFieldSearcher

All Known Implementing Classes:

AbstractCustomFieldSearcher

public interface CustomFieldSearcher

Method Summary

String	getDescription()
CustomFieldSearcherModuleDescriptor	getDescriptor()
String	getKey()
String	getName()
CustomFieldParams	getParamsFromSearchRequest(CustomField customField, SearchRequest searchRequest)
String	getSearchDescription(CustomField field, SearchParameter searchParam)
void	index(org.apache.lucene.document.Document doc, CustomField field, Object value) Add index to the given Document object.
void	init(CustomFieldSearcherModuleDescriptor customFieldSearcherModuleDescriptor)
List	makeSearchParameters(CustomField field, CustomFieldParams params)

Method Detail

init

public void init(CustomFieldSearcherModuleDescriptor customFieldSearcherModuleDescriptor)

getKey

public String getKey()

getName

public String getName()

getDescription

public String getDescription()

getDescriptor

public CustomFieldSearcherModuleDescriptor getDescriptor()

makeSearchParameters

public List makeSearchParameters(CustomField field,
                                 CustomFieldParams params)

getSearchDescription

public String getSearchDescription(CustomField field,
                                   SearchParameter searchParam)

getParamsFromSearchRequest

public CustomFieldParams getParamsFromSearchRequest(CustomField customField,
                                                    SearchRequest searchRequest)

index

public void index(org.apache.lucene.document.Document doc,
                  CustomField field,
                  Object value)

Add index to the given Document object. The "value" is/are the value object (s) returned from the CustomFieldType.

Parameters:

doc -

field -

value -