Package com.atlassian.jira.board

Class DefaultBoardDataService

java.lang.Object

com.atlassian.jira.board.DefaultBoardDataService

All Implemented Interfaces:

BoardDataService

public class DefaultBoardDataService
extends Object
implements BoardDataService

Constructor Summary

Constructors

Constructor	Description
DefaultBoardDataService(BoardWorkflowService boardWorkflowService, BoardQueryService boardQueryService, I18nHelper.BeanFactory i18nFactory, IssueSearchLimits issueSearchLimits, SearchService searchService)

Method Summary

Modifier and Type	Method	Description
ServiceOutcome<BoardData>	getDataForBoard(ApplicationUser user, Board board)	As the given user, get the data for a board.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultBoardDataService

public DefaultBoardDataService(BoardWorkflowService boardWorkflowService,
 BoardQueryService boardQueryService,
 I18nHelper.BeanFactory i18nFactory,
 IssueSearchLimits issueSearchLimits,
 SearchService searchService)

Method Details

getDataForBoard

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

Description copied from interface: BoardDataService

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.

Specified by:

getDataForBoard in interface BoardDataService

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

invalid reference

com.atlassian.jira.util.ErrorCollection.Reason.VALIDATION_FAILED

if there was an error parsing the JQL, or

invalid reference

com.atlassian.jira.util.ErrorCollection.Reason.SERVER_ERROR

if there was an exception while searching