com.pyxis.greenhopper.jira.boards
Interface Board

All Known Subinterfaces:

BoardWithCapacities, BoardWithMarkers, PlanningBoard

All Known Implementing Classes:

AbstractBoard, AbstractModalBoard, AbstractNestableBoard, AbstractPlanningBoard, ArchivedChartBoard, AssigneeBoard, ChartBoard, ChartOverviewBoard, ComponentBoard, CreatingBoard, GadgetBoard, LabelBoard, MovingBoard, OrphanStepBoard, OrphanTaskBoard, ParentStepBoard, ParentTaskBoard, PrintBoard, ProjectBoard, QuerySearchBoard, RankingBoard, SearchBoard, SimpleCardBoard, StepBoard, SubRankingBoard, SubtaskBoard, TaskBoard, TransitionBoard, UpdatingBoard, VersionBoard

public interface Board

Method Summary

boolean	canBoardRank()
boolean	canDrag(BoardIssue issue)
boolean	canManageStats()
boolean	canRank(BoardIssue boardIssue) Retrieves whether or not the ranking is enabled in the board
boolean	canSelect(BoardIssue issue)
int	computeStartFor(com.atlassian.jira.issue.Issue issue, int fallBackStart) Retrieves the page number where the issue is displayed
boolean	containsIssue(com.atlassian.jira.issue.MutableIssue issueObject) Checks if whether or not the issue is associated with the board
void	focusOn(java.lang.String issueKey, int start)
java.util.List<com.atlassian.jira.issue.Issue>	getAllIssues(boolean filter) Retrieves ALL issues associated with the board.
BoardContext	getBoardContext() Retrieves the BoardContext
BoardIssue	getBoardIssue(com.atlassian.jira.issue.Issue issue) Retrieves the decorated isssue
java.lang.String	getBoxCss()
Context	getContext() Retrieves the selected context of the board
java.lang.String	getCursor(BoardIssue boardIssue) Retrieves the cursor of the issue based on the possible actions
java.lang.String	getDecoratedName() Retrieves the decorated name of the board
java.lang.String	getDisplayableBoardForIssue(com.atlassian.jira.issue.Issue issue) Retrieves the id of the board where the issue is displayed in
com.atlassian.query.Query	getDisplayQuery(boolean filter) Builds the query of the issues to display on the board
java.util.List<com.atlassian.jira.issue.Issue>	getHighLightedIssues()
java.lang.String	getId() Retrieves the unique id of the board'
java.util.List<com.atlassian.jira.issue.Issue>	getIssues(boolean filter, com.atlassian.jira.web.bean.PagerFilter pager) Retrieves all issues associated with the board.
java.util.List<com.atlassian.jira.issue.Issue>	getIssuesInPage(int start) Retrieves the issues associated with the board at the specified page start
IssueView	getIssueView()
java.lang.String	getKey() Retrieves the key of the board
int	getMaxIssues() Retrieves the maximum number of issues that can be displayed
int	getMaxPagine()
java.lang.String	getName() Retrieves the name of the board
com.atlassian.query.Query	getNavigatorQuery() Builds the pretty query (names instead of ids) to retrieve the issues associated with the board
Pagination	getPagination()
com.atlassian.jira.project.Project	getProject() Retrieves the project that the board is associated to
java.lang.Long	getProjectId() Retrieves the id of the project that the board is associated to
com.atlassian.query.Query	getQuery(boolean filter) Builds the query to retrieve the issues associated with the board
int	getStart()
BoardSummary	getSummary(boolean filter) Retrieves the statistic component of the board
java.lang.String	getView() The issue view to display the issues in
boolean	hasMenuItems(BoardIssue issue) Returns whether or not the issue has menu items to display in the card menu
boolean	hasSettings() Checks if the board has settings
boolean	hideDone()
boolean	hideSubs()
boolean	isAssignedToMeOn() Returns whether or not only the user issues should be displayed
boolean	isAssociatedWith(com.atlassian.jira.issue.Issue issue) Checks whether the issue is associated with this board, e.g.
boolean	isCapacitySupported()
boolean	isCardsDisplayed()
boolean	isHighLighting()
boolean	isListDisplayed()
boolean	isLocked()
boolean	isMarkersSupported()
boolean	isModifierOn()
boolean	isSelectable() Returns whether or not the board can be selected
int	issueCount() Retrieves the number of issues associated with the board under the context.
boolean	isSummariesDisplayed()
boolean	showLegendBar() Show or not the Legend bar
boolean	showParentSubInfo() Show or not the parent/sub info
boolean	showProgressStats() Returns whether or not the progress related stats (timetracking, status) can be shown
boolean	showStats() Returns whether or not the watched fields stats can be shown

Method Detail

getId

java.lang.String getId()

Retrieves the unique id of the board'

Returns:

the unique id of the board'

getName

java.lang.String getName()

Retrieves the name of the board

Returns:

the name

getDecoratedName

java.lang.String getDecoratedName()

Retrieves the decorated name of the board

Returns:

the decorated name of the board

getKey

java.lang.String getKey()

Retrieves the key of the board

Returns:

the name

getBoardContext

BoardContext getBoardContext()

Retrieves the BoardContext

Returns:

the BoardContext

getContext

Context getContext()

Retrieves the selected context of the board

Returns:

the Context

getProject

com.atlassian.jira.project.Project getProject()

Retrieves the project that the board is associated to

Returns:

the Project

getProjectId

java.lang.Long getProjectId()

Retrieves the id of the project that the board is associated to

Returns:

the id of the project that the board is associated to

getQuery

com.atlassian.query.Query getQuery(boolean filter)

Builds the query to retrieve the issues associated with the board

Parameters:

filter - true if the query should filter based on the context

Returns:

the Query

getNavigatorQuery

com.atlassian.query.Query getNavigatorQuery()

Builds the pretty query (names instead of ids) to retrieve the issues associated with the board

Returns:

the Query

getDisplayQuery

com.atlassian.query.Query getDisplayQuery(boolean filter)

Builds the query of the issues to display on the board

Parameters:

filter - true if the query should filter based on the context

Returns:

the Query

issueCount

int issueCount()

Retrieves the number of issues associated with the board under the context.

Returns:

the number of issues

getIssues

java.util.List<com.atlassian.jira.issue.Issue> getIssues(boolean filter,
                                                         com.atlassian.jira.web.bean.PagerFilter pager)

Retrieves all issues associated with the board. Note: This does not load all results into memory and provides better performance than getAllIssues(boolean filter)

Parameters:

filter - true if the query should filter based on the context

pager - Pager filter

Returns:

A collection of issue Issues

getAllIssues

java.util.List<com.atlassian.jira.issue.Issue> getAllIssues(boolean filter)

Retrieves ALL issues associated with the board. To use if only the complete list of issues is required. Use getIssues(boolean filter, PagerFilter pager) instead.

Parameters:

filter - true if the query should filter based on the context

Returns:

A collection of issue Issues

getDisplayableBoardForIssue

java.lang.String getDisplayableBoardForIssue(com.atlassian.jira.issue.Issue issue)
                                             throws GreenHopperException

Retrieves the id of the board where the issue is displayed in

Parameters:

issue - to locate

Returns:

the id of the board

Throws:

GreenHopperException - if none found

isAssociatedWith

boolean isAssociatedWith(com.atlassian.jira.issue.Issue issue)

Checks whether the issue is associated with this board, e.g. whether the issue version is the same or a sub version of this boards version

getIssuesInPage

java.util.List<com.atlassian.jira.issue.Issue> getIssuesInPage(int start)

Retrieves the issues associated with the board at the specified page start

Parameters:

start - pager start

Returns:

A collection of issue Issues

computeStartFor

int computeStartFor(com.atlassian.jira.issue.Issue issue,
                    int fallBackStart)

Retrieves the page number where the issue is displayed

Parameters:

issue -

fallBackStart -

Returns:

page number where the issue is displayed

getPagination

Pagination getPagination()

getStart

int getStart()

focusOn

void focusOn(java.lang.String issueKey,
             int start)

getMaxPagine

int getMaxPagine()

containsIssue

boolean containsIssue(com.atlassian.jira.issue.MutableIssue issueObject)

Checks if whether or not the issue is associated with the board

Parameters:

issueObject -

getSummary

BoardSummary getSummary(boolean filter)

Retrieves the statistic component of the board

Parameters:

filter - true if the query should filter based on the context

Returns:

the board BoardSummary

isModifierOn

boolean isModifierOn()

Returns:

whether or not a modifier is enabled

hideSubs

boolean hideSubs()

Returns:

if the subtasks should be hidden or not

hideDone

boolean hideDone()

Returns:

if the don issues should be hidden or not

isAssignedToMeOn

boolean isAssignedToMeOn()

Returns whether or not only the user issues should be displayed

Returns:

true if only the user issues needs to be displayed

hasMenuItems

boolean hasMenuItems(BoardIssue issue)

Returns whether or not the issue has menu items to display in the card menu

Parameters:

issue - the selected issue

Returns:

true if any menu has any items

getBoardIssue

BoardIssue getBoardIssue(com.atlassian.jira.issue.Issue issue)

Retrieves the decorated isssue

Parameters:

issue -

Returns:

the BoardIssue

getCursor

java.lang.String getCursor(BoardIssue boardIssue)

Retrieves the cursor of the issue based on the possible actions

Parameters:

boardIssue -

Returns:

the String url path of the cursor

getMaxIssues

int getMaxIssues()

Retrieves the maximum number of issues that can be displayed

Returns:

the maximum number of issues that can be displayed

hasSettings

boolean hasSettings()

Checks if the board has settings

Returns:

true if the board has settings

showStats

boolean showStats()

Returns whether or not the watched fields stats can be shown

Returns:

true if the watched fields stats can be shown

showProgressStats

boolean showProgressStats()

Returns whether or not the progress related stats (timetracking, status) can be shown

Returns:

true if the progress related stats can be shown

showParentSubInfo

boolean showParentSubInfo()

Show or not the parent/sub info

Returns:

true if the parent/sub info should be shown

showLegendBar

boolean showLegendBar()

Show or not the Legend bar

Returns:

true if the Legend bar should be shown

isSelectable

boolean isSelectable()

Returns whether or not the board can be selected

Returns:

true if the board can be selected

isMarkersSupported

boolean isMarkersSupported()

isCapacitySupported

boolean isCapacitySupported()

getView

java.lang.String getView()

The issue view to display the issues in

Returns:

true if the context bar should be shown

isLocked

boolean isLocked()

Returns:

whether or not the board is locked.

isCardsDisplayed

boolean isCardsDisplayed()

Returns:

whether or not the Cards are displayed

isSummariesDisplayed

boolean isSummariesDisplayed()

Returns:

whether or not the summary are displayed

isListDisplayed

boolean isListDisplayed()

Returns:

whether or not the list is displayed

canSelect

boolean canSelect(BoardIssue issue)

Returns:

whether or not the issue can be selected in the board

canRank

boolean canRank(BoardIssue boardIssue)

Retrieves whether or not the ranking is enabled in the board

Returns:

True if ranking is enabled in the board

canDrag

boolean canDrag(BoardIssue issue)

Returns:

whether or not the issue can be dragged in the board

canBoardRank

boolean canBoardRank()

Returns:

whether or not the ranking is enabled in the board

canManageStats

boolean canManageStats()

isHighLighting

boolean isHighLighting()

getHighLightedIssues

java.util.List<com.atlassian.jira.issue.Issue> getHighLightedIssues()

getBoxCss

java.lang.String getBoxCss()

getIssueView

IssueView getIssueView()