com.pyxis.greenhopper.jira.boards
Class PrintBoard

java.lang.Object
  com.pyxis.greenhopper.jira.boards.AbstractBoard
      com.pyxis.greenhopper.jira.boards.AbstractPlanningBoard
          com.pyxis.greenhopper.jira.boards.PrintBoard

All Implemented Interfaces:

Board, BoardWithCapacities, BoardWithMarkers, PlanningBoard, java.lang.Comparable<Board>

public class PrintBoard
extends AbstractPlanningBoard

Field Summary

Fields inherited from class com.pyxis.greenhopper.jira.boards.AbstractBoard

canBoardRank, context, id, issueView, log, name, pager

Fields inherited from interface com.pyxis.greenhopper.jira.boards.PlanningBoard

KEY, VIEW

Constructor Summary

PrintBoard(PlanningBoard board)

Method Summary

com.atlassian.jira.jql.builder.JqlClauseBuilder	applyAsFilter(com.atlassian.jira.jql.builder.JqlClauseBuilder builder, boolean pretty)
boolean	canBoardRank()
boolean	canDrag(BoardIssue issue)
boolean	canEditName() Can edit a box label
boolean	canRank(BoardIssue boardIssue) Retrieves whether or not the ranking is enabled in the board
boolean	canSelect(BoardIssue issue)
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
protected ColumnPagination	getBoardColumnPagination() Retrieves the board column pagination
BoardIssue	getBoardIssue(com.atlassian.jira.issue.Issue issue) Retrieves the decorated isssue
Context	getContext() Retrieves the selected context of the board
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
com.atlassian.query.Query	getDisplayQuery(boolean filter) Builds the query of the issues to display on the board
int	getMaxIssues() Retrieves the maximum number of issues that can be displayed
com.atlassian.query.Query	getNavigatorQuery() Builds the pretty query (names instead of ids) to retrieve the issues associated with the board
java.lang.Integer	getPageBreak()
Pagination	getPagination()
com.atlassian.query.Query	getQuery(boolean filter) Builds the query to retrieve the issues associated with the board
java.util.Collection<com.atlassian.jira.issue.Issue>	getSubtasks(SubtaskBoard parent) Retrieves the subtasks of the specified parent that are associated with the board
java.lang.String	getView() The issue view to display the issues in
boolean	hasDescription() Checks if the board has a description
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	hasSubtasks(SubtaskBoard parent) Checks if the parent has some subtasks associated with the board
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	isCardsDisplayed()
boolean	isHighLighting()
boolean	isInSame(com.atlassian.jira.issue.Issue issue1, com.atlassian.jira.issue.Issue issue2) Checks if both issues are in the same board
boolean	isListDisplayed()
boolean	isSelectable() Returns whether or not the board can be selected
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
void	updateName(java.lang.String name) Updates the name of the board
int	updatePermission()

Methods inherited from class com.pyxis.greenhopper.jira.boards.AbstractPlanningBoard

canEditSettings, canManage, getAllByBoardFilterKey, getAllByBoardFilters, getBoardCapacityKey, getBoardMarkerKey, getByBoardFilter, getCapacityDescription, getCapacityKey, getCapacityTitle, getColumnPagination, getCursor, getKey, getMarkerKey, getPrettyQuery, getQuery, isByBoardFilterSupported, isCapacitySupported, isTaskBoardAvailable, isUnset, setByBoardFilterId

Methods inherited from class com.pyxis.greenhopper.jira.boards.AbstractBoard

canManageStats, compareTo, computeStartFor, containsIssue, equals, focusOn, getAllIssues, getBoardContext, getBoxCss, getDecoratedName, getDefaultStart, getDescription, getDisplayableIssues, getDisplayableIssuesFrom, getFocussedIssue, getHighLightedIssues, getId, getIssueKeys, getIssues, getIssues, getIssuesInPage, getIssueView, getMaxPagine, getName, getPageNumber, getPager, getPager, getPluginLinks, getProject, getProjectId, getRawName, getStart, getSummary, hashCode, hideDone, indexOf, isLocked, isMarkersSupported, isModifierOn, isProjectAdmin, issueCount, issuePagineCount, truncate

Methods inherited from class java.lang.Object

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

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

canManageStats

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

computeStartFor, containsIssue, focusOn, getAllIssues, getBoardContext, getBoxCss, getDecoratedName, getHighLightedIssues, getId, getIssues, getIssuesInPage, getIssueView, getMaxPagine, getName, getProject, getProjectId, getStart, getSummary, hideDone, isLocked, isMarkersSupported, isModifierOn, issueCount

Constructor Detail

PrintBoard

public PrintBoard(PlanningBoard board)

Method Detail

canDrag

public boolean canDrag(BoardIssue issue)

Returns:

whether or not the issue can be dragged in the board

getView

public java.lang.String getView()

Description copied from interface: Board

The issue view to display the issues in

Returns:

true if the context bar should be shown

hasSettings

public boolean hasSettings()

Description copied from interface: Board

Checks if the board has settings

Returns:

true if the board has settings

getPageBreak

public java.lang.Integer getPageBreak()

applyAsFilter

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

isAssociatedWith

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

Description copied from interface: Board

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

getContext

public Context getContext()

Description copied from interface: Board

Retrieves the selected context of the board

Specified by:

getContext in interface Board

Overrides:

getContext in class AbstractBoard

Returns:

the Context

getQuery

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

Description copied from interface: Board

Builds the query to retrieve the issues associated with the board

Specified by:

getQuery in interface Board

Overrides:

getQuery in class AbstractBoard

Parameters:

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

Returns:

the Query

getNavigatorQuery

public com.atlassian.query.Query getNavigatorQuery()

Description copied from interface: Board

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

Specified by:

getNavigatorQuery in interface Board

Overrides:

getNavigatorQuery in class AbstractBoard

Returns:

the Query

getDisplayQuery

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

Description copied from interface: Board

Builds the query of the issues to display on the board

Specified by:

getDisplayQuery in interface Board

Overrides:

getDisplayQuery in class AbstractBoard

Parameters:

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

Returns:

the Query

getPagination

public Pagination getPagination()

Specified by:

getPagination in interface Board

Overrides:

getPagination in class AbstractBoard

hideSubs

public boolean hideSubs()

Specified by:

hideSubs in interface Board

Overrides:

hideSubs in class AbstractBoard

Returns:

if the subtasks should be hidden or not

isAssignedToMeOn

public boolean isAssignedToMeOn()

Description copied from interface: Board

Returns whether or not only the user issues should be displayed

Specified by:

isAssignedToMeOn in interface Board

Overrides:

isAssignedToMeOn in class AbstractBoard

Returns:

true if only the user issues needs to be displayed

hasMenuItems

public boolean hasMenuItems(BoardIssue issue)

Description copied from interface: Board

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

Specified by:

hasMenuItems in interface Board

Overrides:

hasMenuItems in class AbstractBoard

Parameters:

issue - the selected issue

Returns:

true if any menu has any items

getMaxIssues

public int getMaxIssues()

Description copied from interface: Board

Retrieves the maximum number of issues that can be displayed

Specified by:

getMaxIssues in interface Board

Overrides:

getMaxIssues in class AbstractBoard

Returns:

the maximum number of issues that can be displayed

showStats

public boolean showStats()

Description copied from interface: Board

Returns whether or not the watched fields stats can be shown

Specified by:

showStats in interface Board

Overrides:

showStats in class AbstractBoard

Returns:

true if the watched fields stats can be shown

showProgressStats

public boolean showProgressStats()

Description copied from interface: Board

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

Specified by:

showProgressStats in interface Board

Overrides:

showProgressStats in class AbstractBoard

Returns:

true if the progress related stats can be shown

showParentSubInfo

public boolean showParentSubInfo()

Description copied from interface: Board

Show or not the parent/sub info

Specified by:

showParentSubInfo in interface Board

Overrides:

showParentSubInfo in class AbstractBoard

Returns:

true if the parent/sub info should be shown

showLegendBar

public boolean showLegendBar()

Description copied from interface: Board

Show or not the Legend bar

Specified by:

showLegendBar in interface Board

Specified by:

showLegendBar in interface PlanningBoard

Overrides:

showLegendBar in class AbstractPlanningBoard

Returns:

true if the Legend bar should be shown

isSelectable

public boolean isSelectable()

Description copied from interface: Board

Returns whether or not the board can be selected

Specified by:

isSelectable in interface Board

Overrides:

isSelectable in class AbstractBoard

Returns:

true if the board can be selected

canSelect

public boolean canSelect(BoardIssue issue)

Specified by:

canSelect in interface Board

Overrides:

canSelect in class AbstractBoard

Returns:

whether or not the issue can be selected in the board

canRank

public boolean canRank(BoardIssue boardIssue)

Description copied from interface: Board

Retrieves whether or not the ranking is enabled in the board

Specified by:

canRank in interface Board

Overrides:

canRank in class AbstractBoard

Returns:

True if ranking is enabled in the board

canBoardRank

public boolean canBoardRank()

Specified by:

canBoardRank in interface Board

Overrides:

canBoardRank in class AbstractPlanningBoard

Returns:

whether or not the ranking is enabled in the board

isHighLighting

public boolean isHighLighting()

Specified by:

isHighLighting in interface Board

Overrides:

isHighLighting in class AbstractBoard

getBoardIssue

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

Description copied from interface: Board

Retrieves the decorated isssue

Specified by:

getBoardIssue in interface Board

Overrides:

getBoardIssue in class AbstractBoard

Returns:

the BoardIssue

isCardsDisplayed

public boolean isCardsDisplayed()

Specified by:

isCardsDisplayed in interface Board

Overrides:

isCardsDisplayed in class AbstractBoard

Returns:

whether or not the Cards are displayed

isSummariesDisplayed

public boolean isSummariesDisplayed()

Specified by:

isSummariesDisplayed in interface Board

Overrides:

isSummariesDisplayed in class AbstractBoard

Returns:

whether or not the summary are displayed

isListDisplayed

public boolean isListDisplayed()

Specified by:

isListDisplayed in interface Board

Overrides:

isListDisplayed in class AbstractBoard

Returns:

whether or not the list is displayed

canEditName

public boolean canEditName()

Description copied from interface: PlanningBoard

Can edit a box label

Returns:

true if the user can edit the box label

doUpdate

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

Description copied from interface: PlanningBoard

Will associate all issues with the new board

Parameters:

issues - issues to update

boardId - Id of the board to associate

Throws:

java.lang.Exception

doUpdateReport

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

Description copied from interface: PlanningBoard

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

getDescription

public java.lang.String getDescription()

Description copied from interface: PlanningBoard

Retrieves the description of the board

Returns:

the description of the board

getSubtasks

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

Description copied from interface: PlanningBoard

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

Returns:

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

hasDescription

public boolean hasDescription()

Description copied from interface: PlanningBoard

Checks if the board has a description

Returns:

true if the board has a description

hasSubtasks

public boolean hasSubtasks(SubtaskBoard parent)

Description copied from interface: PlanningBoard

Checks if the parent has some subtasks associated with the board

Returns:

true if the parent has some subtasks associated with the board

isInSame

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

Description copied from interface: PlanningBoard

Checks if both issues are in the same board

Returns:

true if both issues are in the same board

updateName

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

Description copied from interface: PlanningBoard

Updates the name of the board

Parameters:

name - the new name of the board

Throws:

java.lang.Exception

updatePermission

public int updatePermission()

Returns:

the Permission to Update

getDisplayableBoardForIssue

public 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

Parameters:

issue - to locate

Returns:

the id of the board

getBoardColumnPagination

protected ColumnPagination getBoardColumnPagination()

Description copied from class: AbstractPlanningBoard

Retrieves the board column pagination

Specified by:

getBoardColumnPagination in class AbstractPlanningBoard

Returns:

the ColumnPagination