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
Modifier and TypeMethodDescriptioncount(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query) Counts entities matching query.<T extends IssueDataCallback>
ServiceResultfind(com.atlassian.jira.user.ApplicationUser 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>
ServiceResultfind(com.atlassian.jira.user.ApplicationUser 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>
ServiceResultfindAndSort(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query, T callback) Performs a search taking sorting into account<T extends IssueDataCallback>
ServiceResultfindAndSortOverrideSecurity(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query, T callback) <T extends IssueDataCallback>
ServiceResultfindAndSortWithServiceOutcome(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query, T callback, com.atlassian.jira.web.bean.PagerFilter<?> pager) <T extends IssueDataCallback>
ServiceResultfindOverrideSecurity(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query, T callback) Executes a find, but overwrites security.<T extends IssueDataCallback>
ServiceResultfindWithServiceOutcome(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query, T callback)
-
Method Details
-
find
@Nonnull <T extends IssueDataCallback> ServiceResult find(com.atlassian.jira.user.ApplicationUser 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
@Nonnull <T extends IssueDataCallback> ServiceResult findWithServiceOutcome(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query, T callback) -
findWithServiceOutcome
@Nonnull <T extends org.apache.lucene.search.Collector> ServiceResult findWithServiceOutcome(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query, T collector) -
find
@Nonnull <T extends IssueDataCallback> ServiceResult find(com.atlassian.jira.user.ApplicationUser 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
@Nonnull <T extends IssueDataCallback> ServiceResult findAndSort(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query, T callback) Performs a search taking sorting into account -
findAndSortWithServiceOutcome
@Nonnull <T extends IssueDataCallback> ServiceResult findAndSortWithServiceOutcome(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query, T callback, com.atlassian.jira.web.bean.PagerFilter<?> pager) -
findOverrideSecurity
@Nonnull <T extends IssueDataCallback> ServiceResult findOverrideSecurity(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query, T callback) Executes a find, but overwrites security. -
findAndSortOverrideSecurity
<T extends IssueDataCallback> ServiceResult findAndSortOverrideSecurity(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query, T callback) -
count
@Nonnull ServiceOutcome<Long> count(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query query) Counts entities matching query.- Parameters:
user- userquery- query- Returns:
- count entities matching query
-