com.atlassian.greenhopper.service.issuelink
Interface EpicService

All Known Implementing Classes:

EpicServiceImpl

public interface EpicService

Service layer for manipulating Epics.

Method Summary

ServiceOutcome<java.lang.Void>	associateIssuesWithEpic(com.atlassian.crowd.embedded.api.User user, com.atlassian.jira.issue.Issue epic, java.util.Set<com.atlassian.jira.issue.Issue> issues) Associate one or more issues with an epic.
ServiceOutcome<java.lang.Void>	disassociateEpicFromIssues(com.atlassian.crowd.embedded.api.User user, java.util.Set<com.atlassian.jira.issue.Issue> issues) Disassociates the issues from the epic(s) they are associated with.
ServiceOutcome<EpicNamesResult>	listEpicNames(com.atlassian.crowd.embedded.api.User user, java.lang.String searchTerm, int maxResults, com.atlassian.jira.project.Project prioritizedProject) Returns a result object containing the matching epic names.

Method Detail

associateIssuesWithEpic

@Nonnull
ServiceOutcome<java.lang.Void> associateIssuesWithEpic(com.atlassian.crowd.embedded.api.User user,
                                                               @Nonnull
                                                               com.atlassian.jira.issue.Issue epic,
                                                               @Nonnull
                                                               java.util.Set<com.atlassian.jira.issue.Issue> issues)

Associate one or more issues with an epic.

Parameters:

user - the user performing the operation

epic - the epic

issues - the issues

Returns:

the outcome

disassociateEpicFromIssues

@Nonnull
ServiceOutcome<java.lang.Void> disassociateEpicFromIssues(com.atlassian.crowd.embedded.api.User user,
                                                                  @Nonnull
                                                                  java.util.Set<com.atlassian.jira.issue.Issue> issues)

Disassociates the issues from the epic(s) they are associated with.

Parameters:

user - the user performing the operation

issues - the issues

Returns:

the outcome

listEpicNames

@Nonnull
ServiceOutcome<EpicNamesResult> listEpicNames(com.atlassian.crowd.embedded.api.User user,
                                                      java.lang.String searchTerm,
                                                      int maxResults,
                                                      @Nullable
                                                      com.atlassian.jira.project.Project prioritizedProject)

Returns a result object containing the matching epic names.

Parameters:

user -

searchTerm - The search term to be used to find matching epic names. Matching will occur agains the epic's key and name

maxResults - The maximum amount of matching epic names to be returned.

prioritizedProject - Optional. If search term is blank, the returned epic names will be selected if they belong to the prioritized project

Returns: