com.pyxis.greenhopper.jira.boards
Interface PlanningBoard

All Superinterfaces:

Board, BoardWithCapacities, BoardWithMarkers

All Known Implementing Classes:

AbstractNestableBoard, AbstractPlanningBoard, ArchivedChartBoard, AssigneeBoard, ChartBoard, ChartOverviewBoard, ComponentBoard, GadgetBoard, OrphanTaskBoard, ParentTaskBoard, PrintBoard, ProjectBoard, TaskBoard, VersionBoard

public interface PlanningBoard
extends BoardWithMarkers

Field Summary

static java.lang.String	KEY
static java.lang.String	VIEW

Method Summary

com.atlassian.jira.jql.builder.JqlClauseBuilder	applyAsFilter(com.atlassian.jira.jql.builder.JqlClauseBuilder builder, boolean pretty)
boolean	canEditName() Can edit a box label
boolean	canEditSettings()
boolean	canManage()
boolean	canManageStats()
void	doUpdate(java.util.Set<com.atlassian.jira.issue.Issue> issues, java.lang.String boardId) Will associate all issues with the new board
java.util.List<SubtaskBoard>	doUpdateReport(java.util.Set<com.atlassian.jira.issue.Issue> issues) Retrieves all the standard issues with subtasks that can be part of the update from the defined set of issues
PlanningBoard	getByBoardFilter()
ColumnPagination	getColumnPagination()
java.lang.String	getDescription() Retrieves the description 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
java.util.Collection<com.atlassian.jira.issue.Issue>	getSubtasks(SubtaskBoard parent) Retrieves the subtasks of the specified parent that are associated with the board
boolean	hasDescription() Checks if the board has a description
boolean	hasSubtasks(SubtaskBoard parent) Checks if the parent has some subtasks associated with the board
boolean	isByBoardFilterSupported()
boolean	isInSame(com.atlassian.jira.issue.Issue issue1, com.atlassian.jira.issue.Issue issue2) Checks if both issues are in the same board
boolean	isTaskBoardAvailable()
boolean	isUnset()
void	setByBoardFilterId(java.lang.String boardFilterId)
boolean	showLegendBar() Show or not the Legend bar
void	updateName(java.lang.String name) Updates the name of the board
int	updatePermission()

Methods inherited from interface com.pyxis.greenhopper.jira.boards.BoardWithMarkers

getBoardMarkerKey, getMarkerKey

Methods inherited from interface com.pyxis.greenhopper.jira.boards.BoardWithCapacities

getBoardCapacityKey, getCapacityDescription, getCapacityKey, getCapacityTitle

Methods inherited from interface com.pyxis.greenhopper.jira.boards.Board

canBoardRank, canDrag, canRank, canSelect, computeStartFor, containsIssue, focusOn, getAllIssues, getBoardContext, getBoardIssue, getBoxCss, getContext, getCursor, getDecoratedName, getDisplayQuery, getHighLightedIssues, getId, getIssues, getIssuesInPage, getIssueView, getKey, getMaxIssues, getMaxPagine, getName, getNavigatorQuery, getPagination, getProject, getProjectId, getQuery, getStart, getSummary, getView, hasMenuItems, hasSettings, hideDone, hideSubs, isAssignedToMeOn, isAssociatedWith, isCapacitySupported, isCardsDisplayed, isHighLighting, isListDisplayed, isLocked, isMarkersSupported, isModifierOn, isSelectable, issueCount, isSummariesDisplayed, showParentSubInfo, showProgressStats, showStats

Field Detail

VIEW

static final java.lang.String VIEW

See Also:

Constant Field Values

KEY

static final java.lang.String KEY

See Also:

Constant Field Values

Method Detail

canEditName

boolean canEditName()

Can edit a box label

Returns:

true if the user can edit the box label

updateName

void updateName(java.lang.String name)
                throws java.lang.Exception

Updates the name of the board

Parameters:

name - the new name of the board

Throws:

java.lang.Exception

hasDescription

boolean hasDescription()

Checks if the board has a description

Returns:

true if the board has a description

getDescription

java.lang.String getDescription()

Retrieves the description of the board

Returns:

the description of the board

doUpdateReport

java.util.List<SubtaskBoard> doUpdateReport(java.util.Set<com.atlassian.jira.issue.Issue> issues)

Retrieves all the standard issues with subtasks that can be part of the update from the defined set of issues

Parameters:

issues - Set of issues to retrieve the parents that have candidate subtasks for the update

Returns:

The list of SubtaskBoard

doUpdate

void doUpdate(java.util.Set<com.atlassian.jira.issue.Issue> issues,
              java.lang.String boardId)
              throws java.lang.Exception

Will associate all issues with the new board

Parameters:

issues - issues to update

boardId - Id of the board to associate

Throws:

java.lang.Exception

hasSubtasks

boolean hasSubtasks(SubtaskBoard parent)

Checks if the parent has some subtasks associated with the board

Parameters:

parent -

Returns:

true if the parent has some subtasks associated with the board

getSubtasks

java.util.Collection<com.atlassian.jira.issue.Issue> getSubtasks(SubtaskBoard parent)

Retrieves the subtasks of the specified parent that are associated with the board

Parameters:

parent -

Returns:

the subtasks of the specified parent that are associated with the board

isInSame

boolean isInSame(com.atlassian.jira.issue.Issue issue1,
                 com.atlassian.jira.issue.Issue issue2)

Checks if both issues are in the same board

Parameters:

issue1 -

issue2 -

Returns:

true if both issues are in the same board

updatePermission

int updatePermission()

Returns:

the Permission to Update

applyAsFilter

com.atlassian.jira.jql.builder.JqlClauseBuilder applyAsFilter(com.atlassian.jira.jql.builder.JqlClauseBuilder builder,
                                                              boolean pretty)

getDisplayableBoardForIssue

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

Description copied from interface: Board

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

Specified by:

getDisplayableBoardForIssue in interface Board

Parameters:

issue - to locate

Returns:

the id of the board

canManage

boolean canManage()

canManageStats

boolean canManageStats()

Specified by:

canManageStats in interface Board

canEditSettings

boolean canEditSettings()

getColumnPagination

ColumnPagination getColumnPagination()

showLegendBar

boolean showLegendBar()

Description copied from interface: Board

Show or not the Legend bar

Specified by:

showLegendBar in interface Board

Returns:

true if the Legend bar should be shown

isUnset

boolean isUnset()

isTaskBoardAvailable

boolean isTaskBoardAvailable()

isByBoardFilterSupported

boolean isByBoardFilterSupported()

getByBoardFilter

PlanningBoard getByBoardFilter()

setByBoardFilterId

void setByBoardFilterId(java.lang.String boardFilterId)