com.atlassian.greenhopper.service.issue

Interface IssueDataService

All Known Implementing Classes:

IssueDataServiceImpl

public interface IssueDataService

Provides easy querying of partial issue data. If you need lots of information from an issue, it might be easier to read DocumentIssues, since they already provide hooks to underlying services. This is meant for a few fields only.

Author:

ahennecke

Method Summary

Methods

Modifier and Type	Method and Description
<T extends IssueDataCallback> ServiceOutcome<Void>	find(com.atlassian.crowd.embedded.api.User user, com.atlassian.query.Query query, T callback) Execute the query, and for each issue in the result, extract the data as specified by the fields in the callback and send them over to the callback collector.
<T extends IssueDataCallback> ServiceOutcome<Void>	find(com.atlassian.crowd.embedded.api.User user, com.atlassian.query.Query query, T callback, org.apache.lucene.search.Query andQuery) Allows specifying an "and" lucene query in addition to a callback
<T extends IssueDataCallback> ServiceOutcome<Void>	findAndSort(com.atlassian.crowd.embedded.api.User user, com.atlassian.query.Query query, T callback) Performs a search taking sorting into account
<T extends IssueDataCallback> ServiceOutcome<Void>	findAndSortOverrideSecurity(com.atlassian.crowd.embedded.api.User user, com.atlassian.query.Query query, T callback)
<T extends IssueDataCallback> ServiceOutcome<Void>	findAndSortWithServiceOutcome(com.atlassian.crowd.embedded.api.User user, com.atlassian.query.Query query, T callback, com.atlassian.jira.web.bean.PagerFilter<?> pager)
<T extends IssueDataCallback> ServiceOutcome<Void>	findOverrideSecurity(com.atlassian.crowd.embedded.api.User user, com.atlassian.query.Query query, T callback) Executes a find, but overwrites security.
<T extends IssueDataCallback> ServiceOutcome<Void>	findWithServiceOutcome(com.atlassian.crowd.embedded.api.User user, com.atlassian.query.Query query, T callback)

Method Detail

find

@NotNull
<T extends IssueDataCallback> ServiceOutcome<Void> find(com.atlassian.crowd.embedded.api.User user,
                                                              com.atlassian.query.Query query,
                                                              T callback)

Execute the query, and for each issue in the result, extract the data as specified by the fields in the callback and send them over to the callback collector. For optimal memory usage, try streaming the data directly into the receiving data structure (like a REST template) instead of gathering it internally.

Parameters:

callback - : This collects the field values of the issues matching the query

Returns:

any errors that happened during the search

findWithServiceOutcome

@NotNull
<T extends IssueDataCallback> ServiceOutcome<Void> findWithServiceOutcome(com.atlassian.crowd.embedded.api.User user,
                                                                                com.atlassian.query.Query query,
                                                                                T callback)

find

@NotNull
<T extends IssueDataCallback> ServiceOutcome<Void> find(com.atlassian.crowd.embedded.api.User user,
                                                              com.atlassian.query.Query query,
                                                              T callback,
                                                              org.apache.lucene.search.Query andQuery)

Allows specifying an "and" lucene query in addition to a callback

findAndSort

@NotNull
<T extends IssueDataCallback> ServiceOutcome<Void> findAndSort(com.atlassian.crowd.embedded.api.User user,
                                                                     com.atlassian.query.Query query,
                                                                     T callback)

Performs a search taking sorting into account

findAndSortWithServiceOutcome

@NotNull
<T extends IssueDataCallback> ServiceOutcome<Void> findAndSortWithServiceOutcome(com.atlassian.crowd.embedded.api.User user,
                                                                                       com.atlassian.query.Query query,
                                                                                       T callback,
                                                                                       com.atlassian.jira.web.bean.PagerFilter<?> pager)

findOverrideSecurity

@NotNull
<T extends IssueDataCallback> ServiceOutcome<Void> findOverrideSecurity(com.atlassian.crowd.embedded.api.User user,
                                                                              com.atlassian.query.Query query,
                                                                              T callback)

Executes a find, but overwrites security.

findAndSortOverrideSecurity

<T extends IssueDataCallback> ServiceOutcome<Void> findAndSortOverrideSecurity(com.atlassian.crowd.embedded.api.User user,
                                                                             com.atlassian.query.Query query,
                                                                             T callback)