com.atlassian.greenhopper.service.rapid.view
Interface SwimlaneService

All Superinterfaces:

GreenHopperCache

All Known Implementing Classes:

SwimlaneServiceImpl

public interface SwimlaneService
extends GreenHopperCache

Provides swimlanes configuration related functionality

Field Summary

static java.lang.String	SWIMLANE_DEFAULT_LANE_ERROR_CONTEXT
static java.lang.String	SWIMLANE_DESCRIPTION_ERROR_CONTEXT
static java.lang.String	SWIMLANE_NAME_ERROR_CONTEXT
static java.lang.String	SWIMLANE_QUERY_ERROR_CONTEXT

Method Summary

ServiceOutcome<Swimlane>	add(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, Swimlane swimlane) Adds a new swimlane
void	delete(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, long swimlaneId, ErrorCollection errors) Delete a single swimlane
Swimlane	get(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, long swimlaneId, ErrorCollection errors) Get a swimlane given its id
java.util.Set<SwimlaneStrategy>	getValidStrategies() Get all valid strategies
void	invalidate(RapidView rapidView)
java.util.List<Swimlane>	loadSwimlanes(RapidView rapidView)
ServiceOutcome<java.lang.Void>	moveAfter(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, long swimlaneId, java.lang.Long moveToSwimlaneIds)
ServiceOutcome<java.util.List<Swimlane>>	replace(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, java.util.List<Swimlane> swimlanes) Replaces all swimlanes for a given rapid view with the specified swimlanes (keeping the order in the list).
Swimlane	update(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, Swimlane swimlane, ErrorCollection errors) Updates a single swimlane for a given rapidView

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

flushCache

Field Detail

SWIMLANE_NAME_ERROR_CONTEXT

static final java.lang.String SWIMLANE_NAME_ERROR_CONTEXT

See Also:

Constant Field Values

SWIMLANE_QUERY_ERROR_CONTEXT

static final java.lang.String SWIMLANE_QUERY_ERROR_CONTEXT

See Also:

Constant Field Values

SWIMLANE_DESCRIPTION_ERROR_CONTEXT

static final java.lang.String SWIMLANE_DESCRIPTION_ERROR_CONTEXT

See Also:

Constant Field Values

SWIMLANE_DEFAULT_LANE_ERROR_CONTEXT

static final java.lang.String SWIMLANE_DEFAULT_LANE_ERROR_CONTEXT

See Also:

Constant Field Values

Method Detail

getValidStrategies

java.util.Set<SwimlaneStrategy> getValidStrategies()

Get all valid strategies

loadSwimlanes

java.util.List<Swimlane> loadSwimlanes(RapidView rapidView)

get

Swimlane get(com.atlassian.crowd.embedded.api.User user,
             RapidView rapidView,
             long swimlaneId,
             ErrorCollection errors)

Get a swimlane given its id

add

@Transactional
ServiceOutcome<Swimlane> add(com.atlassian.crowd.embedded.api.User user,
                                           RapidView rapidView,
                                           Swimlane swimlane)

Adds a new swimlane

update

@Transactional
Swimlane update(com.atlassian.crowd.embedded.api.User user,
                              RapidView rapidView,
                              Swimlane swimlane,
                              ErrorCollection errors)

Updates a single swimlane for a given rapidView

replace

@Transactional
ServiceOutcome<java.util.List<Swimlane>> replace(com.atlassian.crowd.embedded.api.User user,
                                                               RapidView rapidView,
                                                               java.util.List<Swimlane> swimlanes)

Replaces all swimlanes for a given rapid view with the specified swimlanes (keeping the order in the list). The default swimlane must be contained in the list of swimlanes, otherwise an error is returned.

delete

@Transactional
void delete(com.atlassian.crowd.embedded.api.User user,
                          RapidView rapidView,
                          long swimlaneId,
                          ErrorCollection errors)

Delete a single swimlane

moveAfter

@Transactional
ServiceOutcome<java.lang.Void> moveAfter(com.atlassian.crowd.embedded.api.User user,
                                                       RapidView rapidView,
                                                       long swimlaneId,
                                                       java.lang.Long moveToSwimlaneIds)

Parameters:

user - the user doing the move

rapidView - the swimlane is associated with

swimlaneId - the id of the swimlane being moved

moveToSwimlaneIds - the id of the swimlane to move the target swimlane after. If null moves the swimlane to the start

Returns:

whether or not the move was successful

invalidate

void invalidate(RapidView rapidView)