com.atlassian.greenhopper.service.sprint

Interface SprintManager

All Superinterfaces:

GreenHopperCache

All Known Implementing Classes:

SprintManagerImpl

public interface SprintManager
extends GreenHopperCache

Sprint manager as well as cache

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<Sprint>	createSprint(Map<String,Object> fields) Create a sprint given the fields
ServiceOutcome<Sprint>	createSprint(Sprint sprint) Create a sprint given the object
ServiceResult	deleteSprint(Sprint sprint) Delete a sprint
ServiceOutcome<Collection<Long>>	getAllSprintIdsByState(Sprint.State state)
ServiceOutcome<Collection<Sprint>>	getAllSprints() Deprecated.
ServiceOutcome<Collection<Sprint>>	getAutoStartStopSprintsByState(Sprint.State state) Returns sprints in the given state managed by the auto start/stop sprints functionality.
ServiceOutcome<Sprint>	getSprint(long id) Get a sprint given its id.
ServiceOutcome<Collection<Sprint>>	getSprints(EnumSet<Sprint.State> states) Collects all sprints with the given states
ServiceOutcome<Collection<Sprint>>	getSprintsByNameAndState(String searchQuery, EnumSet<Sprint.State> states)
ServiceOutcome<Collection<Sprint>>	getSprintsByNameAndStateAndRapidViews(String searchQuery, EnumSet<Sprint.State> states, Set<Long> rapidViewIds)
ServiceOutcome<Collection<Sprint>>	getSprintsForView(Long rapidViewId, EnumSet<Sprint.State> states) Collects all sprints owned by the passed rapid view with one of the given states
ServiceOutcome<Collection<Sprint>>	getSprintsForView(RapidView rapidView) Get all sprints owned by the passed rapid view
ServiceOutcome<SprintStateAuditLog>	getSprintStateAuditLog(Sprint sprint) Gets the audit log data for a sprint
ServiceResult	logStateChange(Sprint updatedSprint, com.atlassian.jira.user.ApplicationUser user) Log the opening/closing of a sprint
ServiceResult	swapSprints(Sprint sprintA, Sprint sprintB) Swap the sequence of the two sprint objects.
ServiceResult	unmapAllSprints()
ServiceOutcome<Sprint>	updateSprint(Sprint sprint) Update a sprint

Methods inherited from interface com.atlassian.greenhopper.manager.GreenHopperCache

flushCache

Method Detail

getSprint

@Nonnull
ServiceOutcome<Sprint> getSprint(long id)

Get a sprint given its id.

getAllSprints

@Nonnull
 @Deprecated
ServiceOutcome<Collection<Sprint>> getAllSprints()

Deprecated.

Get all sprints

getAllSprintIdsByState

@Nonnull
ServiceOutcome<Collection<Long>> getAllSprintIdsByState(Sprint.State state)

getSprints

@Nonnull
ServiceOutcome<Collection<Sprint>> getSprints(EnumSet<Sprint.State> states)

Collects all sprints with the given states

Parameters:

states - the states to include

Returns:

a set of sprints

getSprintsForView

@Nonnull
ServiceOutcome<Collection<Sprint>> getSprintsForView(RapidView rapidView)

Get all sprints owned by the passed rapid view

getSprintsForView

@Nonnull
ServiceOutcome<Collection<Sprint>> getSprintsForView(Long rapidViewId,
                                                              EnumSet<Sprint.State> states)

Collects all sprints owned by the passed rapid view with one of the given states

logStateChange

@Nonnull
ServiceResult logStateChange(Sprint updatedSprint,
                                      com.atlassian.jira.user.ApplicationUser user)

Log the opening/closing of a sprint

getSprintStateAuditLog

@Nonnull
ServiceOutcome<SprintStateAuditLog> getSprintStateAuditLog(Sprint sprint)

Gets the audit log data for a sprint

createSprint

@Transactional
 @Nonnull
ServiceOutcome<Sprint> createSprint(Sprint sprint)

Create a sprint given the object

createSprint

@Transactional
 @Nonnull
ServiceOutcome<Sprint> createSprint(Map<String,Object> fields)

Create a sprint given the fields

updateSprint

@Transactional
 @Nonnull
ServiceOutcome<Sprint> updateSprint(Sprint sprint)

Update a sprint

swapSprints

@Transactional
 @Nonnull
ServiceResult swapSprints(@Nonnull
                                                   Sprint sprintA,
                                                   @Nonnull
                                                   Sprint sprintB)

Swap the sequence of the two sprint objects.

Parameters:

sprintA - the first sprint

sprintB - the other sprint

Returns:

outcome of the operation

deleteSprint

@Transactional
 @Nonnull
ServiceResult deleteSprint(Sprint sprint)

Delete a sprint

unmapAllSprints

@Nonnull
ServiceResult unmapAllSprints()

getSprintsByNameAndState

@Nonnull
ServiceOutcome<Collection<Sprint>> getSprintsByNameAndState(String searchQuery,
                                                                     EnumSet<Sprint.State> states)

getAutoStartStopSprintsByState

@Nonnull
ServiceOutcome<Collection<Sprint>> getAutoStartStopSprintsByState(@Nonnull
                                                                           Sprint.State state)

Returns sprints in the given state managed by the auto start/stop sprints functionality.

Parameters:

state - state of sprints

Returns:

a collection of sprints

getSprintsByNameAndStateAndRapidViews

@Nonnull
ServiceOutcome<Collection<Sprint>> getSprintsByNameAndStateAndRapidViews(String searchQuery,
                                                                                  EnumSet<Sprint.State> states,
                                                                                  Set<Long> rapidViewIds)