@ExperimentalApi
public interface BoardService
Modifier and Type | Method and Description |
---|---|
ServiceOutcome<Board> |
createBoard(ApplicationUser user,
BoardCreationData boardCreationData)
Create a board according to the data provided.
|
ServiceOutcome<Board> |
createDefaultBoardForProject(ApplicationUser user,
long projectId)
Create a default board for the specified project.
|
ServiceOutcome<Boolean> |
deleteBoard(ApplicationUser user,
BoardId boardId)
Delete the board.
|
ServiceOutcome<Board> |
getBoard(ApplicationUser user,
BoardId boardId)
get the board for board id
Get the board for specified board id.
|
ServiceOutcome<List<Board>> |
getBoardsForProject(ApplicationUser user,
long projectId)
Get a list of boards related to the project.
|
ServiceOutcome<Boolean> |
hasBoardInProject(ApplicationUser user,
long projectId)
Returns whether there is at least one visible board for the user in the project.
|
ServiceOutcome<Board> createDefaultBoardForProject(ApplicationUser user, long projectId)
ProjectAction
permission can perform this operation.
We don't validate jql here in order to allow admin without view project permission still can create the board.
Otherwise, this method will return a no permission error.
It returns the newly created board if it's created successfully.user
- the user creating the boardprojectId
- the project idServiceOutcome<Board> createBoard(ApplicationUser user, @Nonnull BoardCreationData boardCreationData)
GlobalPermissionKey
can perform this operation.
Otherwise, this method will return a no permission error.user
- the user creating the boardboardCreationData
- board creation dataServiceOutcome<List<Board>> getBoardsForProject(ApplicationUser user, long projectId)
ProjectAction
permission can perform this operation.
Otherwise, this method will return a no permission error.user
- the user to get the boardsprojectId
- the id of the project to link this board toServiceOutcome<Boolean> hasBoardInProject(ApplicationUser user, long projectId)
user
- the logged in userprojectId
- the project idServiceOutcome<Board> getBoard(ApplicationUser user, @Nonnull BoardId boardId)
user
- the user to get the boardboardId
- the board idServiceOutcome<Boolean> deleteBoard(ApplicationUser user, @Nonnull BoardId boardId)
GlobalPermissionKey
can perform this operation.
Otherwise, it'll get no permission error.
It'll return true when the specified board is deleted successfully. It'll return false if the specified board is not found.user
- the user to delete the boardboardId
- board idCopyright © 2002-2022 Atlassian. All Rights Reserved.