com.pyxis.greenhopper.jira.boards.context
Interface BoardContext

All Superinterfaces:

I18n

All Known Implementing Classes:

AnonymousBoardContext, DefaultBoardContext

public interface BoardContext
extends I18n

Method Summary

void	addWatchedField(java.lang.String fieldId)
java.util.Map<java.lang.String,AssigneeBoard>	getAllAssigneeBoards()
java.util.Set<IssueField>	getAllAvailableWatchedFields()
java.util.Map<java.lang.String,ComponentBoard>	getAllComponentBoards()
java.util.TreeSet<VersionBoard>	getAllSortedArchivedChartBoards()
java.util.TreeSet<VersionBoard>	getAllSortedVersionBoards()
ArchivedChartBoard	getArchivedChartBoard(com.atlassian.jira.project.version.Version version)
java.util.Set<VersionBoard>	getArchivedChartBoards(java.util.Collection<java.lang.String> ids)
AssigneeBoard	getAssigneeBoard(java.lang.String id)
java.util.Map<java.lang.String,java.lang.String>	getCardColors()
CardLayouts	getCardLayouts()
ChartBoard	getChartBoard(com.atlassian.jira.project.version.Version version)
ChartOverviewBoard	getChartOverviewBoard()
ComponentAssociations	getComponentAssociations()
ComponentBoard	getComponentBoard(java.lang.String id)
ProjectConfiguration	getConfiguration() Retrieves the project configuration
Contexts	getContexts()
VersionBoard	getDeepestVersionBoard()
FlagField	getFlagField()
GreenHopper	getGreenHopperService()
IssueFieldManager	getIssueFieldManager()
ListLayouts	getListLayouts()
UserBoardsPreferences	getPreferences() Retrieves the user's project preferences
com.atlassian.jira.project.Project	getProject() Retrieves the board context project
ProjectBoard	getProjectBoard()
java.lang.Long	getProjectId() Retrieves the id of the board context project
java.util.Set<IssueField>	getRankingFields()
VersionAssociations	getReleasedVersionAssociations()
java.util.Map<java.lang.String,VersionBoard>	getReleasedVersionBoards()
CustomFieldMultiVersion	getReleasedVersionHistoryField()
SearchBoard	getSearchBoard(java.lang.String searchType, java.lang.String searchKey)
Context	getSelectedContext(java.lang.String view) Retrieves the selected context of the selected view
java.util.TreeSet<AssigneeBoard>	getSortedAssigneeBoards()
java.util.TreeSet<ComponentBoard>	getSortedComponentBoards()
java.util.Set<IssueField>	getSortedFields()
java.util.TreeSet<VersionBoard>	getSortedReleasedVersionBoards()
java.util.TreeSet<VersionBoard>	getSortedVersionBoards()
SummaryLayouts	getSummaryLayouts()
TaskBoard	getTaskBoard(java.lang.String id)
TaskBoardConfiguration	getTaskBoardConfiguration() Retrieves the project TaskBoardConfiguration
java.util.Map<java.lang.String,VersionBoard>	getUnreleasedVersionBoards()
com.opensymphony.user.User	getUser() Retrieves the user of the board context project
UserBoardSettings	getUserSettings() Retrieves the users project settings
VersionAssociations	getVersionAssociations()
VersionBoard	getVersionBoard(java.lang.String id)
java.util.Set<VersionBoard>	getVersionBoards(java.util.Collection<java.lang.String> ids)
WatchedField	getWatchedField(java.lang.String fieldId)
java.util.Set<WatchedField>	getWatchedFields()
boolean	isEpicLabel(com.atlassian.jira.issue.fields.CustomField field)
boolean	isEpicType(com.atlassian.jira.issue.issuetype.IssueType type)
java.lang.String	pushAssigneeBoardId(java.lang.String id)
java.lang.String	pushChartBoardId(java.lang.String selectedBoardId)
java.lang.String	pushComponentBoardId(java.lang.String id)
java.lang.String	pushVersionBoardId(java.lang.String id, boolean unscheduleAllowed)
void	removeWatchedField(java.lang.String fieldId)
void	saveConfiguration() Saves the project configuration
void	savePreferences() Saves the user's project preferences
void	saveTaskBoardConfiguration() Saves the project TaskBoardConfiguration
void	saveUserSettings() Saves the user's project settings
void	updatePreferences(java.lang.String key, java.lang.Object value) Updates the user's project preferences with the new key/value pair
void	updateUserSettings(java.lang.String key, java.lang.Object value) Updates the user's project settings with the new key/value pair

Methods inherited from interface com.pyxis.greenhopper.jira.util.I18n

getHtmlEncodedText, getText, getText, getText

Method Detail

getConfiguration

ProjectConfiguration getConfiguration()

Retrieves the project configuration

Returns:

the ProjectConfiguration

saveConfiguration

void saveConfiguration()

Saves the project configuration

getTaskBoardConfiguration

TaskBoardConfiguration getTaskBoardConfiguration()

Retrieves the project TaskBoardConfiguration

Returns:

the TaskBoardConfiguration

saveTaskBoardConfiguration

void saveTaskBoardConfiguration()

Saves the project TaskBoardConfiguration

getPreferences

UserBoardsPreferences getPreferences()

Retrieves the user's project preferences

Returns:

the UserBoardsPreferences

updatePreferences

void updatePreferences(java.lang.String key,
                       java.lang.Object value)

Updates the user's project preferences with the new key/value pair

Parameters:

key -

value -

savePreferences

void savePreferences()

Saves the user's project preferences

getUserSettings

UserBoardSettings getUserSettings()

Retrieves the users project settings

Returns:

the UserBoardSettings

updateUserSettings

void updateUserSettings(java.lang.String key,
                        java.lang.Object value)

Updates the user's project settings with the new key/value pair

Parameters:

key -

value -

saveUserSettings

void saveUserSettings()

Saves the user's project settings

getProject

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

Retrieves the board context project

Returns:

a Project

getProjectId

java.lang.Long getProjectId()

Retrieves the id of the board context project

Returns:

the id of the board context project

getUser

com.opensymphony.user.User getUser()

Retrieves the user of the board context project

Returns:

a User

getSelectedContext

Context getSelectedContext(java.lang.String view)

Retrieves the selected context of the selected view

Returns:

Context

isEpicType

boolean isEpicType(com.atlassian.jira.issue.issuetype.IssueType type)

isEpicLabel

boolean isEpicLabel(com.atlassian.jira.issue.fields.CustomField field)

getVersionBoard

VersionBoard getVersionBoard(java.lang.String id)

getDeepestVersionBoard

VersionBoard getDeepestVersionBoard()

getSortedVersionBoards

java.util.TreeSet<VersionBoard> getSortedVersionBoards()

getSortedReleasedVersionBoards

java.util.TreeSet<VersionBoard> getSortedReleasedVersionBoards()

getAllSortedVersionBoards

java.util.TreeSet<VersionBoard> getAllSortedVersionBoards()

getVersionBoards

java.util.Set<VersionBoard> getVersionBoards(java.util.Collection<java.lang.String> ids)

getVersionAssociations

VersionAssociations getVersionAssociations()

getUnreleasedVersionBoards

java.util.Map<java.lang.String,VersionBoard> getUnreleasedVersionBoards()

getReleasedVersionBoards

java.util.Map<java.lang.String,VersionBoard> getReleasedVersionBoards()

getAllComponentBoards

java.util.Map<java.lang.String,ComponentBoard> getAllComponentBoards()

getAllAssigneeBoards

java.util.Map<java.lang.String,AssigneeBoard> getAllAssigneeBoards()

getAllSortedArchivedChartBoards

java.util.TreeSet<VersionBoard> getAllSortedArchivedChartBoards()

Returns:

a tree of Versions (wrapped in ChartBoards), where all released versions are present, plus their respective parent Versions, even if the parent is not yet released.

getArchivedChartBoards

java.util.Set<VersionBoard> getArchivedChartBoards(java.util.Collection<java.lang.String> ids)

getReleasedVersionAssociations

VersionAssociations getReleasedVersionAssociations()

getReleasedVersionHistoryField

CustomFieldMultiVersion getReleasedVersionHistoryField()

pushVersionBoardId

java.lang.String pushVersionBoardId(java.lang.String id,
                                    boolean unscheduleAllowed)

pushChartBoardId

java.lang.String pushChartBoardId(java.lang.String selectedBoardId)

getComponentBoard

ComponentBoard getComponentBoard(java.lang.String id)

getSortedComponentBoards

java.util.TreeSet<ComponentBoard> getSortedComponentBoards()

pushComponentBoardId

java.lang.String pushComponentBoardId(java.lang.String id)

getComponentAssociations

ComponentAssociations getComponentAssociations()

getAssigneeBoard

AssigneeBoard getAssigneeBoard(java.lang.String id)

getSortedAssigneeBoards

java.util.TreeSet<AssigneeBoard> getSortedAssigneeBoards()

pushAssigneeBoardId

java.lang.String pushAssigneeBoardId(java.lang.String id)

getProjectBoard

ProjectBoard getProjectBoard()

getTaskBoard

TaskBoard getTaskBoard(java.lang.String id)

getArchivedChartBoard

ArchivedChartBoard getArchivedChartBoard(com.atlassian.jira.project.version.Version version)

getChartBoard

ChartBoard getChartBoard(com.atlassian.jira.project.version.Version version)

getSearchBoard

SearchBoard getSearchBoard(java.lang.String searchType,
                           java.lang.String searchKey)

getChartOverviewBoard

ChartOverviewBoard getChartOverviewBoard()

getGreenHopperService

GreenHopper getGreenHopperService()

getIssueFieldManager

IssueFieldManager getIssueFieldManager()

getFlagField

FlagField getFlagField()

getWatchedField

WatchedField getWatchedField(java.lang.String fieldId)

addWatchedField

void addWatchedField(java.lang.String fieldId)
                     throws GreenHopperException

Throws:

GreenHopperException

removeWatchedField

void removeWatchedField(java.lang.String fieldId)

getAllAvailableWatchedFields

java.util.Set<IssueField> getAllAvailableWatchedFields()

getWatchedFields

java.util.Set<WatchedField> getWatchedFields()

getSortedFields

java.util.Set<IssueField> getSortedFields()

getRankingFields

java.util.Set<IssueField> getRankingFields()

getCardColors

java.util.Map<java.lang.String,java.lang.String> getCardColors()

getCardLayouts

CardLayouts getCardLayouts()

getSummaryLayouts

SummaryLayouts getSummaryLayouts()

getListLayouts

ListLayouts getListLayouts()

getContexts

Contexts getContexts()