com.atlassian.greenhopper.service.sprint
Interface SprintService

All Known Implementing Classes:

SprintServiceImpl

public interface SprintService

Method Summary

ServiceOutcome<Sprint>	createSprint(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, Sprint sprintData, java.util.Set<com.atlassian.jira.issue.Issue> issues) Create a new sprint. The user needs to have Project Administrator permissions for all issues.
ServiceOutcome<java.lang.Void>	deleteSprint(com.atlassian.crowd.embedded.api.User user, Sprint sprint) Delete a sprint
ServiceOutcome<java.util.Set<Sprint>>	findSprintsByName(com.atlassian.crowd.embedded.api.User user, java.lang.String searchQuery, int maxResults, boolean excludeCompleted) Get a set of sprints matching a search query
ServiceOutcome<Sprint>	getSprint(com.atlassian.crowd.embedded.api.User user, long sprintId) Get a sprint given its id The sprint is only returned if the user can see at least one of the issues assigned to the sprint
ServiceOutcome<java.util.Set<Sprint>>	getSprints(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, java.util.Set<java.lang.Long> sprintIds) Get a set of sprints by id checking each for visibility permission
ServiceOutcome<Sprint>	updateSprint(com.atlassian.crowd.embedded.api.User user, Sprint sprint) Update a sprint

Method Detail

getSprint

@Nonnull
ServiceOutcome<Sprint> getSprint(com.atlassian.crowd.embedded.api.User user,
                                         long sprintId)

Get a sprint given its id The sprint is only returned if the user can see at least one of the issues assigned to the sprint

getSprints

@Nonnull
ServiceOutcome<java.util.Set<Sprint>> getSprints(com.atlassian.crowd.embedded.api.User user,
                                                         RapidView rapidView,
                                                         java.util.Set<java.lang.Long> sprintIds)

Get a set of sprints by id checking each for visibility permission

findSprintsByName

@Nonnull
ServiceOutcome<java.util.Set<Sprint>> findSprintsByName(com.atlassian.crowd.embedded.api.User user,
                                                                java.lang.String searchQuery,
                                                                int maxResults,
                                                                boolean excludeCompleted)

Get a set of sprints matching a search query

Parameters:

user - the user

searchQuery - the string to match sprint names against

excludeCompleted - whether to include completed sprints or not

createSprint

@Nonnull
ServiceOutcome<Sprint> createSprint(com.atlassian.crowd.embedded.api.User user,
                                            RapidView rapidView,
                                            Sprint sprintData,
                                            java.util.Set<com.atlassian.jira.issue.Issue> issues)

Create a new sprint. The user needs to have Project Administrator permissions for all issues.

Parameters:

user - the user

rapidView - the sprint's rapid view

sprintData - the sprint object to persist

issues - the issues to include in the sprint

updateSprint

@Nonnull
ServiceOutcome<Sprint> updateSprint(com.atlassian.crowd.embedded.api.User user,
                                            Sprint sprint)

Update a sprint

deleteSprint

@Nonnull
ServiceOutcome<java.lang.Void> deleteSprint(com.atlassian.crowd.embedded.api.User user,
                                                    Sprint sprint)

Delete a sprint