@ExperimentalApi public interface

BoardDataService

com.atlassian.jira.board.BoardDataService
Known Indirect Subclasses

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

Provides services for performing operations on a board's data, which describes the issues, statuses, assignees and columns for a given board.

Summary

Public Methods
ServiceOutcome<BoardData> getDataForBoard(ApplicationUser user, Board board)
As the given user, get the data for a board.

Public Methods

public ServiceOutcome<BoardData> getDataForBoard (ApplicationUser user, Board board)

As the given user, get the data for a board. This will return an object containing the issues, statuses, assignees and columns for the board. The columns will also be ordered based on the status they contain, with the initial statuses of all workflows in the board's query context appearing first, and then the rest sorted first by status category and then by status id. There will be an error if an exception occurs while retrieving the board's issues, or if there is an error while parsing the board JQL.

Parameters
user the user to retrieve the data for the board as
board the board to get the data for
Returns
  • the board data if successful, or com.atlassian.jira.util.ErrorCollection.Reason.VALIDATION_FAILED if there was an error parsing the JQL, or com.atlassian.jira.util.ErrorCollection.Reason.SERVER_ERROR if there was an exception while searching