|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SearchHandlerManager
Manager that holds all references to search related information in JIRA.
Method Summary | |
---|---|
Collection<IssueSearcher<?>> |
getAllSearchers()
Return all the active searchers in JIRA. |
Collection<ClauseHandler> |
getClauseHandler(String jqlClauseName)
Return a collection of ClauseHandler s registered against the passed JQL clause
name. |
Collection<ClauseHandler> |
getClauseHandler(User user,
String jqlClauseName)
Return a collection of ClauseHandler s registered against the passed JQL clause
name. |
Collection<String> |
getFieldIds(String jqlClauseName)
Gets the field ids that are associated with the provided jqlClauseName. |
Collection<String> |
getFieldIds(User searcher,
String jqlClauseName)
Gets the field ids that are associated with the provided jqlClauseName. |
Collection<ClauseNames> |
getJqlClauseNames(String fieldId)
Get the ClauseNames associated with the provided field name. |
IssueSearcher<?> |
getSearcher(String id)
Get a searcher by the searchers name. |
Collection<SearcherGroup> |
getSearcherGroups(SearchContext searchContext)
Get all searcher groups with the IssueSearcher that are applicable for the context. |
Collection<IssueSearcher<?>> |
getSearchers(User searcher,
SearchContext context)
Get searchers that are applicable for a given context. |
Collection<IssueSearcher<?>> |
getSearchersByClauseName(User user,
String jqlClauseName,
SearchContext searchContext)
Return a collection of IssueSearcher s registered against the
passed JQL clause name. |
Collection<ClauseNames> |
getVisibleJqlClauseNames(User searcher)
Get all the available clause names that the searcher can see. |
void |
refresh()
Refreshes the SearchHandlerManager . |
Method Detail |
---|
Collection<IssueSearcher<?>> getSearchers(User searcher, SearchContext context)
com.atlassian.jira.issue.search.searchers.IssueSearcher#getSearchRenderer()#isShown(com.atlassian.jira.issue.search.SearchContext)
method.
searcher
- performing this action.context
- for the list of searchers. Must not be null
IssueSearcher
Collection<IssueSearcher<?>> getAllSearchers()
Collection<SearcherGroup> getSearcherGroups(SearchContext searchContext)
IssueSearcher
that are applicable for the context. com.atlassian.jira.issue.search.searchers.IssueSearcher#getSearchRenderer()#isShown(SearchContext)
method. Note
that the SearcherGroup
will still appear even if no IssueSearcher
are shown for the group.
searchContext
- for the searcher groups.
SearcherGroup
IssueSearcher<?> getSearcher(String id)
id
- the string identifier returned by com.atlassian.jira.issue.search.searchers.IssueSearcher#getSearchInformation()#getId()
void refresh()
SearchHandlerManager
.
@NotNull Collection<ClauseHandler> getClauseHandler(User user, String jqlClauseName)
ClauseHandler
s registered against the passed JQL clause
name. This will only return the handlers that the user has permission to see as specified by the ClausePermissionChecker.hasPermissionToUseClause(com.opensymphony.user.User)
method. The reason this is returning a collection is that custom fields can have the same JQL clause name and
therefore resolve to multiple clause handlers, this will never be the case for System fields, we don't allow it!
user
- that will be used to perform a permission check.jqlClauseName
- the clause name to search for.
@NotNull Collection<ClauseHandler> getClauseHandler(String jqlClauseName)
ClauseHandler
s registered against the passed JQL clause
name. This will return all available handlers, regardless of permissions. The reason this is returning a collection
is that custom fields can have the same JQL clause name and therefore resolve to multiple clause handlers, this
will never be the case for System fields, we don't allow it!
jqlClauseName
- the clause name to search for.
@NotNull Collection<ClauseNames> getJqlClauseNames(String fieldId)
ClauseNames
associated with the provided field name.
A collection can be returned because it is possible for multiple clause handlers to register against the same
field.
fieldId
- the Field.getId()
.
ClauseNames
associated with the provided field name. Empty collection
is returned when the field has no JQL names (i.e. no clause handlers) associated with it.@NotNull Collection<String> getFieldIds(User searcher, String jqlClauseName)
ClausePermissionChecker.hasPermissionToUseClause(com.opensymphony.user.User)
method.
searcher
- that will be used to perform a permission check.jqlClauseName
- the clause name to find the field id for.
@NotNull Collection<String> getFieldIds(String jqlClauseName)
jqlClauseName
- the clause name to find the field id for.
@NotNull Collection<ClauseNames> getVisibleJqlClauseNames(User searcher)
searcher
- that will be used to perform a permission check.
ClauseNames
visible to the user. Empty collection
is returned when the can see no clauses.@NotNull Collection<IssueSearcher<?>> getSearchersByClauseName(User user, String jqlClauseName, SearchContext searchContext)
IssueSearcher
s registered against the
passed JQL clause name. This will only return the IssueSearchers that the user has permission to see as specified
by the SearchRenderer.isShown(com.opensymphony.user.User,com.atlassian.jira.issue.search.SearchContext)
method.
user
- that will be used to perform a permission check.jqlClauseName
- the clause name to search for.searchContext
- the search context under which the searchers must be shown
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |