SprintIssueService (Atlassian GreenHopper 6.6.60 API)

All Known Implementing Classes:

SprintIssueServiceImpl
```
public interface SprintIssueService
```
Manipulates sprint information stored against issues.

Since:

v5.8.5

Author:

mtokar

Method Summary

Methods
Modifier and Type	Method and Description
`ServiceOutcome<Void>`	`addIssuesToSprint(com.atlassian.crowd.embedded.api.User user, Sprint sprint, Collection<com.atlassian.jira.issue.Issue> issues)` Updates the Default Sprint field on the specified issues to have the value of the specified `Sprint`.
`ServiceOutcome<com.atlassian.fugue.Option<Sprint>>`	`getActiveOrFutureSprintForIssue(com.atlassian.crowd.embedded.api.User user, com.atlassian.jira.issue.Issue issue)` Returns any future or active sprint for an issue
`ServiceOutcome<com.atlassian.fugue.Option<Sprint>>`	`getActiveSprintForIssue(com.atlassian.crowd.embedded.api.User user, com.atlassian.jira.issue.Issue issue)` Returns any future sprints for an issue
`ServiceOutcome<com.atlassian.fugue.Option<Sprint>>`	`getFutureSprintForIssue(com.atlassian.crowd.embedded.api.User user, com.atlassian.jira.issue.Issue issue)` Returns any future sprint for an issue
`ServiceOutcome<List<com.atlassian.jira.issue.Issue>>`	`getIssuesForSprint(com.atlassian.crowd.embedded.api.User user, Sprint sprint)` Gets the issues assigned to a given sprint Note: This returns the issues in the given sprint RIGHT NOW! if you want issues which _have_ been in the sprint at some point, look at SprintHistoryService
`ServiceOutcome<Collection<Sprint>>`	`getSprintsForIssue(com.atlassian.crowd.embedded.api.User user, com.atlassian.jira.issue.Issue issue)` Returns all sprints an issue is currently assigned to.
`ServiceOutcome<List<com.atlassian.jira.issue.Issue>>`	`removeAllIssuesFromSprint(com.atlassian.crowd.embedded.api.User user, Sprint sprint)` Removes all issues currently assigned to given sprint.
`ServiceOutcome<Void>`	`removeIssuesFromSprint(com.atlassian.crowd.embedded.api.User user, Sprint sprint, Collection<com.atlassian.jira.issue.Issue> issues)` removes the specified issues from a given sprint
`ServiceOutcome<Void>`	`updateFutureActiveSprintOrBacklog(com.atlassian.crowd.embedded.api.User user, Sprint sprint, Collection<com.atlassian.jira.issue.Issue> issues)` Updates the Default Sprint field on the specified issues to have the value of the specified `Sprint`.

Method Detail

updateFutureActiveSprintOrBacklog
```
@NotNull
ServiceOutcome<Void> updateFutureActiveSprintOrBacklog(com.atlassian.crowd.embedded.api.User user,
                                                             Sprint sprint,
                                                             Collection<com.atlassian.jira.issue.Issue> issues)
```
Updates the Default Sprint field on the specified issues to have the value of the specified Sprint.
Validation of the issue update is performed against all issues before attempting an update.
Note: if validation passes but the update operation does not, it is possible that some issues will have already been updated even though errors have been returned.

Parameters:
user - the user performing the sprint assignment
sprint - the sprint to assign issues to, null will remove issues from currently assigned active sprints
issues - the issues to put into the sprint

Returns:
an outcome which contains the errors which occurred (if any)

addIssuesToSprint
```
@NotNull
ServiceOutcome<Void> addIssuesToSprint(com.atlassian.crowd.embedded.api.User user,
                                             Sprint sprint,
                                             Collection<com.atlassian.jira.issue.Issue> issues)
```
Updates the Default Sprint field on the specified issues to have the value of the specified Sprint.
Validation of the issue update is performed against all issues before attempting an update.
Note: if validation passes but the update operation does not, it is possible that some issues will have already been updated even though errors have been returned.

Parameters:
user - the user performing the sprint assignment
sprint - the sprint to assign issues to
issues - the issues to put into the sprint

Returns:
an outcome which contains the errors which occurred (if any)

getIssuesForSprint
```
@NotNull
ServiceOutcome<List<com.atlassian.jira.issue.Issue>> getIssuesForSprint(com.atlassian.crowd.embedded.api.User user,
                                                                              Sprint sprint)
```
Gets the issues assigned to a given sprint Note: This returns the issues in the given sprint RIGHT NOW! if you want issues which _have_ been in the sprint at some point, look at SprintHistoryService

Parameters:
user - the user performing the query
sprint - the sprint to query

Returns:
an outcome which contains the issues for this sprint

removeIssuesFromSprint

@NotNull
ServiceOutcome<Void> removeIssuesFromSprint(com.atlassian.crowd.embedded.api.User user,
                                                  Sprint sprint,
                                                  Collection<com.atlassian.jira.issue.Issue> issues)

removes the specified issues from a given sprint

Parameters:: user - the user performing the sprint operation; sprint - the sprint to remove issues from; issues - the issues to remove from the sprint
Returns:: an outcome containing any errors which occured

removeAllIssuesFromSprint

@NotNull
ServiceOutcome<List<com.atlassian.jira.issue.Issue>> removeAllIssuesFromSprint(com.atlassian.crowd.embedded.api.User user,
                                                                                     Sprint sprint)

Removes all issues currently assigned to given sprint. Used before deleting a sprint

getSprintsForIssue

@NotNull
ServiceOutcome<Collection<Sprint>> getSprintsForIssue(com.atlassian.crowd.embedded.api.User user,
                                                            com.atlassian.jira.issue.Issue issue)

Returns all sprints an issue is currently assigned to. Basically the Sprint objects stored in the Sprint custom field

getActiveSprintForIssue

@NotNull
ServiceOutcome<com.atlassian.fugue.Option<Sprint>> getActiveSprintForIssue(com.atlassian.crowd.embedded.api.User user,
                                                                                 com.atlassian.jira.issue.Issue issue)

Returns any future sprints for an issue

getFutureSprintForIssue

@NotNull
ServiceOutcome<com.atlassian.fugue.Option<Sprint>> getFutureSprintForIssue(com.atlassian.crowd.embedded.api.User user,
                                                                                 com.atlassian.jira.issue.Issue issue)

Returns any future sprint for an issue

getActiveOrFutureSprintForIssue

@NotNull
ServiceOutcome<com.atlassian.fugue.Option<Sprint>> getActiveOrFutureSprintForIssue(com.atlassian.crowd.embedded.api.User user,
                                                                                         com.atlassian.jira.issue.Issue issue)

Returns any future or active sprint for an issue

Interface SprintIssueService