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

All Known Implementing Classes:

BoardAdminServiceImpl

public interface BoardAdminService

Method Summary

java.util.List<BoardAdmin>	getBoardAdmins(RapidView view) Retrieve a List of BoardAdmins associated with a particular RapidView
boolean	isUserBoardAdmin(RapidView rapidView, com.atlassian.crowd.embedded.api.User user) Check whether or not a given User is a Board Admin of a given RapidView.
ServiceOutcome<java.util.List<BoardAdmin>>	setInitialBoardAdmin(RapidView rapidView, com.atlassian.crowd.embedded.api.User user) Make the specified User the single initial Board Admin for the RapidView
ServiceOutcome<java.util.List<BoardAdmin>>	updateBoardAdmins(RapidView rapidView, com.atlassian.crowd.embedded.api.User user, java.util.List<BoardAdmin> newBoardAdmin) Updates the BoardAdmins associated with a RapidView by replacing the existing BoardAdmins with those found in the new specified list.

Method Detail

getBoardAdmins

java.util.List<BoardAdmin> getBoardAdmins(RapidView view)

Retrieve a List of BoardAdmins associated with a particular RapidView

Parameters:

view - The view which you wish to retrieve associated Board Admins for.

Returns:

List containing Board Admins associated with the specifiec RapidView

updateBoardAdmins

@Nonnull
@Transactional
ServiceOutcome<java.util.List<BoardAdmin>> updateBoardAdmins(RapidView rapidView,
                                                                                   com.atlassian.crowd.embedded.api.User user,
                                                                                   java.util.List<BoardAdmin> newBoardAdmin)

Updates the BoardAdmins associated with a RapidView by replacing the existing BoardAdmins with those found in the new specified list.

Parameters:

rapidView - The RapidView you are updating the BoardAdmins of.

newBoardAdmin - The list of new Board Admins to update with.

Returns:

The updated list of BoardAdmins

isUserBoardAdmin

@Nonnull
boolean isUserBoardAdmin(RapidView rapidView,
                                 com.atlassian.crowd.embedded.api.User user)

Check whether or not a given User is a Board Admin of a given RapidView.

Parameters:

rapidView - The RapidView to check the User against.

user - The User in question.

Returns:

Whether or not the User is a BoardAdmin of the RapidView

setInitialBoardAdmin

@Nonnull
ServiceOutcome<java.util.List<BoardAdmin>> setInitialBoardAdmin(RapidView rapidView,
                                                                        com.atlassian.crowd.embedded.api.User user)

Make the specified User the single initial Board Admin for the RapidView

Parameters:

rapidView - The rapid view

user - The user to make the BoardAdmin

Returns:

The "list" containing the new BoardAdmin