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, Sprint sprintToCreate, java.util.Set<com.atlassian.jira.issue.Issue> issues, boolean ensureSprintDatesOccurAfterIssueUpdates)
          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<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)
           
 ServiceOutcome<Sprint> updateSprint(com.atlassian.crowd.embedded.api.User user, Sprint sprint)
          Update a sprint
 

Method Detail

getSprint

@NotNull
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

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

createSprint

@NotNull
ServiceOutcome<Sprint> createSprint(com.atlassian.crowd.embedded.api.User user,
                                            Sprint sprintToCreate,
                                            java.util.Set<com.atlassian.jira.issue.Issue> issues,
                                            boolean ensureSprintDatesOccurAfterIssueUpdates)
Create a new sprint. The user needs to have Project Administrator permissions for all issues.

Parameters:
user - the user
sprintToCreate - the sprint object to persist
issues - the issues to include in the sprint
ensureSprintDatesOccurAfterIssueUpdates - if this flag is set to true, sprints with a start date in the past will be "forward dated" so that they actually start at the instant after all issues have been added to the sprint. This is to ensure that the adding of issues to the sprint does not show up as scope change in burndowns.

updateSprint

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


deleteSprint

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



Copyright © 2007-2012 Atlassian. All Rights Reserved.