Package com.atlassian.jira.plugin.report

Class DefaultReportSubTaskFetcher

java.lang.Object

com.atlassian.jira.plugin.report.DefaultReportSubTaskFetcher

All Implemented Interfaces:

ReportSubTaskFetcher

public class DefaultReportSubTaskFetcher
extends Object
implements ReportSubTaskFetcher

Constructor Summary

Constructors

Constructor	Description
DefaultReportSubTaskFetcher(SearchService searchService, IssueSearchLimits issueSearchLimits)

Method Summary

Modifier and Type	Method	Description
List<Issue>	getSubTasks(ApplicationUser user, List<Issue> parentIssues, SubTaskInclusionOption subtaskInclusion, boolean onlyIncludeUnresolved)	Given a list of parent issues, returns a list of subtasks visible to the user, subject to the subtask inclusion policy at SubTaskInclusionOption.
List<Issue>	getSubTasks(ApplicationUser user, List<Issue> parentIssues, SubTaskInclusionOption subtaskInclusion, boolean onlyIncludeUnresolved, int limit)	Given a list of parent issues, returns a list of subtasks visible to the user, subject to the subtask inclusion policy at SubTaskInclusionOption.
List<Issue>	getSubTasksForUser(ApplicationUser user, List<Issue> parentIssues, SubTaskInclusionOption subtaskInclusion, boolean onlyIncludeUnresolved)	Given a list of parent issues, returns a list of subtasks visible to the user, subject to the subtask inclusion policy at SubTaskInclusionOption.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultReportSubTaskFetcher

public DefaultReportSubTaskFetcher(SearchService searchService,
 IssueSearchLimits issueSearchLimits)

Method Details

getSubTasks

public List<Issue> getSubTasks(ApplicationUser user,
 List<Issue> parentIssues,
 SubTaskInclusionOption subtaskInclusion,
 boolean onlyIncludeUnresolved)
                        throws SearchException

Description copied from interface: ReportSubTaskFetcher

Given a list of parent issues, returns a list of subtasks visible to the user, subject to the subtask inclusion policy at SubTaskInclusionOption. Will return at most IssueSearchLimits.getSearchPlatformMaxResultWindow() subtasks.

Will return an empty list if nothing found.

Specified by:

getSubTasks in interface ReportSubTaskFetcher

Parameters:

user - For permission checks

parentIssues - A list of parent issues

subtaskInclusion - A String that is one of the SubTaskInclusionOption. If subtaskInclusion is null, an empty list is returned.

onlyIncludeUnresolved - Whether to only include unresolved, or to include both resolved and unresolved issues

Returns:

a List of Issues that are subtasks.

Throws:

SearchException - if the search subsystem fails.

getSubTasks

public List<Issue> getSubTasks(ApplicationUser user,
 List<Issue> parentIssues,
 SubTaskInclusionOption subtaskInclusion,
 boolean onlyIncludeUnresolved,
 int limit)
                        throws SearchException

Description copied from interface: ReportSubTaskFetcher

Given a list of parent issues, returns a list of subtasks visible to the user, subject to the subtask inclusion policy at SubTaskInclusionOption.

Will return an empty list if nothing found.

Specified by:

getSubTasks in interface ReportSubTaskFetcher

Parameters:

user - For permission checks

parentIssues - A list of parent issues

subtaskInclusion - A String that is one of the SubTaskInclusionOption. If subtaskInclusion is null, an empty list is returned.

onlyIncludeUnresolved - Whether to only include unresolved, or to include both resolved and unresolved issues

limit - A limit on number of subtasks to be returned

Returns:

a List of Issues that are subtasks.

Throws:

SearchException - if the search subsystem fails.

getSubTasksForUser

public List<Issue> getSubTasksForUser(ApplicationUser user,
 List<Issue> parentIssues,
 SubTaskInclusionOption subtaskInclusion,
 boolean onlyIncludeUnresolved)
                               throws SearchException

Description copied from interface: ReportSubTaskFetcher

Given a list of parent issues, returns a list of subtasks visible to the user, subject to the subtask inclusion policy at SubTaskInclusionOption.

Will return an empty list if nothing found.

Specified by:

getSubTasksForUser in interface ReportSubTaskFetcher

Parameters:

user - for permission checks

parentIssues - a List of Issues

subtaskInclusion - @Nullable a String that is one of the SubTaskInclusionOption If subtaskInclusion is null, an empty list is returned.

onlyIncludeUnresolved - whether to only include unresolved, or to include both resolved and unresolved issues

Returns:

a List of Issues that are subtasks.

Throws:

SearchException - if the search subsystem fails.