com.atlassian.greenhopper.manager.cardlayout

Interface CardLayoutManager

All Superinterfaces:

GreenHopperCache

All Known Implementing Classes:

CardLayoutManagerImpl

public interface CardLayoutManager
extends GreenHopperCache

Manager for card layouts.

Since:

v6.5

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<CardLayoutField>	add(RapidView rapidView, CardLayoutField cardLayoutField) Add a card layout field at the beginning of the card layout field configuration for a specific board.
ServiceOutcome<List<CardLayoutField>>	copy(RapidView sourceRapidView, RapidView targetRapidView) Copy card layout from source rapid view to target rapid view
ServiceResult	delete(RapidView rapidView, long cardLayoutFieldId) Remove a given layout configuration item.
ServiceOutcome<List<CardLayoutField>>	getAll(RapidView rapidView) Return a list of card layout fields for a given board.
void	invalidate(RapidView view) invalidates the cache entry for a given rapid view.
ServiceResult	moveAfter(RapidView rapidView, long cardLayoutFieldId, io.atlassian.fugue.Option<Long> optionalFieldIdToMoveAfter) Move a field after another field.

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

flushCache

Method Detail

getAll

ServiceOutcome<List<CardLayoutField>> getAll(@Nonnull
                                             RapidView rapidView)

Return a list of card layout fields for a given board.

Parameters:

rapidView - is the board

Returns:

a list of card layout fields

add

@Transactional
ServiceOutcome<CardLayoutField> add(RapidView rapidView,
                                                   CardLayoutField cardLayoutField)

Add a card layout field at the beginning of the card layout field configuration for a specific board.

Parameters:

rapidView - is the board configuration

cardLayoutField - is the card layout field to be added

Returns:

service outcome

delete

@Transactional
ServiceResult delete(RapidView rapidView,
                                    long cardLayoutFieldId)

Remove a given layout configuration item.

Parameters:

rapidView - the rapid view

cardLayoutFieldId - the item id

Returns:

nothing

moveAfter

@Transactional
ServiceResult moveAfter(RapidView rapidView,
                                       long cardLayoutFieldId,
                                       io.atlassian.fugue.Option<Long> optionalFieldIdToMoveAfter)

Move a field after another field.

Parameters:

rapidView - the rapid view

cardLayoutFieldId - the field Id to move

optionalFieldIdToMoveAfter - the field to move after, or when empty then move to beginning

Returns:

copy

@Transactional
ServiceOutcome<List<CardLayoutField>> copy(RapidView sourceRapidView,
                                                          RapidView targetRapidView)

Copy card layout from source rapid view to target rapid view

Parameters:

sourceRapidView - the source RapidView

targetRapidView - the target RapidView to copy to

Returns:

ServiceOutcome

invalidate

void invalidate(RapidView view)

invalidates the cache entry for a given rapid view.