View Javadoc

1   package com.atlassian.jira.bc.search;
2   
3   import java.util.Collection;
4   
5   import com.atlassian.jira.bc.JiraServiceContext;
6   
7   public interface PickerSearchService {
8   
9   	/**
10      * Get an Entity based on a query string.
11      * Matches on the start of id, each word in shortDescription & description 
12      *
13      * @param jiraServiceContext Jira Service Context
14      * @param query              String to search for.
15      * @return Collection of objects that match criteria.
16      */
17     public Collection getResults(JiraServiceContext jiraServiceContext, String entityName, String query);
18  
19     /**
20      * Returns true only if Picker Ajax search is enabled
21      *
22      * @return True if enabled, otherwise false
23      * @param jiraServiceContext Jira Service Context
24      */
25     public boolean canPerformAjaxSearch(JiraServiceContext jiraServiceContext);
26  
27     /**
28      * Returns true only if Picker Ajax search is enabled.
29      * @return true if enabled.
30      */
31     public boolean isAjaxSearchEnabled();
32  
33  }