com.atlassian.jira.plugin.report

Interface ReportSubTaskFetcher

All Known Implementing Classes:

DefaultReportSubTaskFetcher

@InjectableComponent
public interface ReportSubTaskFetcher

Responsible for getting SubTasks for parent Issues.

Since:

v6.3

Method Summary

Modifier and Type	Method and 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.

Method Detail

getSubTasks

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

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.

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

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

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.

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

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

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.

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.