com.pyxis.greenhopper.jira.boards
Class ComponentBoard

java.lang.Object
  com.pyxis.greenhopper.jira.boards.AbstractBoard
      com.pyxis.greenhopper.jira.boards.AbstractPlanningBoard
          com.pyxis.greenhopper.jira.boards.AbstractNestableBoard
              com.pyxis.greenhopper.jira.boards.ComponentBoard

All Implemented Interfaces:

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

public class ComponentBoard
extends AbstractNestableBoard

Field Summary

static java.lang.String

VIEW

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

Constructor Summary

ComponentBoard(BoardContext boardContext)

ComponentBoard(BoardContext boardContext, com.atlassian.jira.bc.project.component.ProjectComponent component)

Method Summary

com.atlassian.jira.jql.builder.JqlClauseBuilder	applyAsFilter(com.atlassian.jira.jql.builder.JqlClauseBuilder builder, boolean pretty)
boolean	canDrag(BoardIssue boardIssue)
boolean	canEditName() Can edit a box label
void	doSynchronize() Fixes all issues that are not respecting the board hierarchy by assigning the missing boards to the issue.
java.util.Set<com.atlassian.jira.issue.Issue>	doSynchronizeReport() Retreives all issues that are not respecting the hierarchy of boards.
void	doUpdate(java.util.Set<com.atlassian.jira.issue.Issue> issues, java.lang.String boardId) TODO Need to check if field is required...
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
java.util.TreeSet<ComponentBoard>	getAllBoards()
java.util.Set<VersionBoard>	getAllByBoardFilters()
Associations	getAssociations() Retrieves the associations
protected ColumnPagination	getBoardColumnPagination() Retrieves the board column pagination
PlanningBoard	getByBoardFilter()
com.atlassian.jira.bc.project.component.ProjectComponent	getComponent()
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.lang.String	getLead()
com.atlassian.jira.bc.project.component.ProjectComponent	getMaster()
protected java.lang.String	getPendingKey()
com.atlassian.query.Query	getPendingQuery(boolean filter) Builds the query to show only the pending issues
java.util.List<com.atlassian.jira.bc.project.component.ProjectComponent>	getPossibleMasters()
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	hasSettings() Checks if the board has settings
boolean	hasSubtasks(SubtaskBoard parent) Checks if the parent has some subtasks associated with the board
boolean	isAssociatedWith(com.atlassian.jira.issue.Issue issue) Checks whether the issue is associated with this board, e.g.
boolean	isInSame(com.atlassian.jira.issue.Issue issue1, com.atlassian.jira.issue.Issue issue2) Checks if both issues are in the same board
boolean	isLeadable()
void	setByBoardFilterId(java.lang.String boardFilterId)
void	synchronize()
java.util.Set<com.atlassian.jira.issue.Issue>	synchronizeReport()
java.lang.String	truncate(java.lang.String s)
void	updateMaster(java.lang.String masterId) Updates the master of the board
void	updateName(java.lang.String name) Updates the name of the board
int	updatePermission()

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

compareTo, getBoxCss, getDecoratedName, getDisplayQuery, getHierarchy, getMasterId, hasChildren, isInHierarchy, isMaster, isModifierOn, showPending

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

canBoardRank, canEditSettings, canManage, getAllByBoardFilterKey, getBoardCapacityKey, getBoardMarkerKey, getCapacityDescription, getCapacityKey, getCapacityTitle, getColumnPagination, getCursor, getKey, getMarkerKey, getPrettyQuery, getQuery, isByBoardFilterSupported, isCapacitySupported, isTaskBoardAvailable, isUnset, showLegendBar

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

canManageStats, canRank, canSelect, computeStartFor, containsIssue, equals, focusOn, getAllIssues, getBoardContext, getBoardIssue, getContext, getDefaultStart, getDescription, getDisplayableIssues, getDisplayableIssuesFrom, getFocussedIssue, getHighLightedIssues, getId, getIssueKeys, getIssues, getIssues, getIssuesInPage, getIssueView, getMaxIssues, getMaxPagine, getName, getNavigatorQuery, getPageNumber, getPager, getPager, getPagination, getPluginLinks, getProject, getProjectId, getQuery, getRawName, getStart, getSummary, hashCode, hasMenuItems, hideDone, hideSubs, indexOf, isAssignedToMeOn, isCardsDisplayed, isHighLighting, isListDisplayed, isLocked, isMarkersSupported, isProjectAdmin, isSelectable, issueCount, issuePagineCount, isSummariesDisplayed, showParentSubInfo, showProgressStats, showStats

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

canRank, canSelect, computeStartFor, containsIssue, focusOn, getAllIssues, getBoardContext, getBoardIssue, getContext, getHighLightedIssues, getId, getIssues, getIssuesInPage, getIssueView, getMaxIssues, getMaxPagine, getName, getNavigatorQuery, getPagination, getProject, getProjectId, getQuery, getStart, getSummary, hasMenuItems, hideDone, hideSubs, isAssignedToMeOn, isCardsDisplayed, isHighLighting, isListDisplayed, isLocked, isMarkersSupported, isSelectable, issueCount, isSummariesDisplayed, showParentSubInfo, showProgressStats, showStats

Field Detail

VIEW

public static final java.lang.String VIEW

See Also:

Constant Field Values

Constructor Detail

ComponentBoard

public ComponentBoard(BoardContext boardContext,
                      com.atlassian.jira.bc.project.component.ProjectComponent component)

ComponentBoard

public ComponentBoard(BoardContext boardContext)

Method Detail

getComponent

public com.atlassian.jira.bc.project.component.ProjectComponent getComponent()

getMaster

public com.atlassian.jira.bc.project.component.ProjectComponent getMaster()

isLeadable

public boolean isLeadable()

getLead

public java.lang.String getLead()

synchronize

public void synchronize()

synchronizeReport

public java.util.Set<com.atlassian.jira.issue.Issue> synchronizeReport()

getPossibleMasters

public java.util.List<com.atlassian.jira.bc.project.component.ProjectComponent> getPossibleMasters()

getAllBoards

public java.util.TreeSet<ComponentBoard> getAllBoards()

getPendingQuery

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

Description copied from interface: NestableBoard

Builds the query to show only the pending issues

Returns:

the query to show only the pending issues

getAssociations

public Associations getAssociations()

Description copied from interface: NestableBoard

Retrieves the associations

Returns:

Associations

doSynchronize

public void doSynchronize()

Description copied from interface: NestableBoard

Fixes all issues that are not respecting the board hierarchy by assigning the missing boards to the issue.

doSynchronizeReport

public java.util.Set<com.atlassian.jira.issue.Issue> doSynchronizeReport()

Description copied from interface: NestableBoard

Retreives all issues that are not respecting the hierarchy of boards.

Returns:

all issues that are not respecting the hierarchy of boards.

updateMaster

public void updateMaster(java.lang.String masterId)
                  throws java.lang.Exception

Description copied from interface: NestableBoard

Updates the master of the board

Parameters:

masterId - the new master

Throws:

java.lang.Exception

canDrag

public boolean canDrag(BoardIssue boardIssue)

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

getAllByBoardFilters

public java.util.Set<VersionBoard> getAllByBoardFilters()

Overrides:

getAllByBoardFilters in class AbstractPlanningBoard

getDescription

public java.lang.String getDescription()

Description copied from interface: PlanningBoard

Retrieves the description of the board

Returns:

the description of 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

canEditName

public boolean canEditName()

Description copied from interface: PlanningBoard

Can edit a box label

Returns:

true if the user can edit the box label

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

doUpdate

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

TODO Need to check if field is required...

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

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

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

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

applyAsFilter

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

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

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

getByBoardFilter

public PlanningBoard getByBoardFilter()

Specified by:

getByBoardFilter in interface PlanningBoard

Overrides:

getByBoardFilter in class AbstractPlanningBoard

setByBoardFilterId

public void setByBoardFilterId(java.lang.String boardFilterId)

Specified by:

setByBoardFilterId in interface PlanningBoard

Overrides:

setByBoardFilterId in class AbstractPlanningBoard

truncate

public java.lang.String truncate(java.lang.String s)

Overrides:

truncate in class AbstractBoard

updatePermission

public int updatePermission()

Returns:

the Permission to Update

getBoardColumnPagination

protected ColumnPagination getBoardColumnPagination()

Description copied from class: AbstractPlanningBoard

Retrieves the board column pagination

Specified by:

getBoardColumnPagination in class AbstractPlanningBoard

Returns:

the ColumnPagination

getPendingKey

protected java.lang.String getPendingKey()

Specified by:

getPendingKey in class AbstractNestableBoard