com.atlassian.greenhopper.web.rapid
Class BoardDispatchAction

java.lang.Object
  webwork.action.ActionSupport
      com.atlassian.jira.action.JiraActionSupport
          com.atlassian.jira.web.action.JiraWebActionSupport
              com.atlassian.greenhopper.web.GreenHopperWebActionSupport
                  com.atlassian.greenhopper.web.rapid.BoardDispatchAction

All Implemented Interfaces:

com.atlassian.jira.util.ErrorCollection, com.atlassian.jira.util.I18nHelper, com.atlassian.jira.web.HttpServletVariables, com.atlassian.jira.web.util.AuthorizationSupport, java.io.Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

public class BoardDispatchAction
extends GreenHopperWebActionSupport

Action which either redirects the user to the single board which an issue/sprint is on, or presents the user with a list of boards which it appears on so they can be redirected to the right place. This action also an "inline dialog" -- like JIRA issue operations, it serves back its content for presentation as a dialog when triggered from the right place.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

com.atlassian.jira.web.action.JiraWebActionSupport.MessageType

Nested classes/interfaces inherited from interface com.atlassian.jira.util.ErrorCollection

com.atlassian.jira.util.ErrorCollection.Reason

Nested classes/interfaces inherited from interface com.atlassian.jira.util.I18nHelper

com.atlassian.jira.util.I18nHelper.BeanFactory

Field Summary

static java.lang.String

BOARD_SELECTOR

Fields inherited from class com.atlassian.greenhopper.web.GreenHopperWebActionSupport

ERROR_DIALOG_CANCEL, ERROR_DIALOG_SIMPLE, greenHopperHelpPathResolver

Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

ISSUE_NOT_FOUND_RESULT, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters

Fields inherited from class com.atlassian.jira.action.JiraActionSupport

log

Fields inherited from class webwork.action.ActionSupport

command, errorMap, errorMessages

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

BoardDispatchAction()

Method Summary

java.lang.String	doGoToBoard() Given only an issueId or sprintId, this command will attempt to redirect the user to the location of that issue or sprint on a Rapid Board.
java.lang.String	doGoToIssueOnBoard() Given an issueId and a rapidViewId, this command will redirect the user to the location of that issue on that Rapid Board.
java.lang.String	doGoToSprintOnBoard() Given a sprintId and a rapidViewId, this command will redirect the user to the location of that sprint on that Rapid Board.
java.util.List<RapidView>	getBoards()
com.atlassian.jira.issue.Issue	getIssue()
java.lang.Long	getIssueId()
java.lang.Integer	getNumBoards()
java.lang.Long	getRapidViewId()
Sprint	getSprint()
java.lang.Long	getSprintId()
boolean	isIssueRequest()
void	setIssueId(java.lang.Long issueId)
void	setRapidViewId(java.lang.Long rapidViewId)
void	setSprintId(java.lang.Long sprintId)

Methods inherited from class com.atlassian.greenhopper.web.GreenHopperWebActionSupport

attachErrors, getHelpPath, getI18n, getJiraHelpPath, getResourceTags, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getUtil, isHostedEnvironment

Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addMessageToResponse, addReason, addReasons, forceRedirect, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDescTranslation, getDmyDateFormatter, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getJiraContactHelper, getJiraServiceContext, getLanguage, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getTimeFormat, getUriValidator, getUserFullName, getUserManager, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, hasIssuePermission, hasPermission, hasProjectPermission, htmlEncode, insertContextPath, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isInlineDialogMode, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, urlEncode

Methods inherited from class com.atlassian.jira.action.JiraActionSupport

addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getComponentInstanceOfType, getDefaultResourceBundle, getDelegator, getI18nHelper, getKeysForPrefix, getLocale, getOfBizDelegator, getRemoteUser, getResourceBundle, getResult, getUnescapedText, getUntransformedRawText, getUserPreferences, getWatcherManager, hasAnyErrors, isIndexing, isKeyDefined, removeKeyOrAddError

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doDefault, doExecute, doValidation, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.util.ErrorCollection

addError, addErrorMessage, addErrorMessages, addErrors, hasAnyErrors, setErrorMessages

Methods inherited from interface webwork.action.CommandDriven

setCommand

Field Detail

BOARD_SELECTOR

public static final java.lang.String BOARD_SELECTOR

See Also:

Constant Field Values

Constructor Detail

BoardDispatchAction

public BoardDispatchAction()

Method Detail

doGoToBoard

public java.lang.String doGoToBoard()

Given only an issueId or sprintId, this command will attempt to redirect the user to the location of that issue or sprint on a Rapid Board.

If multiple boards contain this issue or sprint, the result will be a list of options to the user, so that they can select which Board to be redirected to.

doGoToIssueOnBoard

public java.lang.String doGoToIssueOnBoard()

Given an issueId and a rapidViewId, this command will redirect the user to the location of that issue on that Rapid Board.

Note: this is where the links in doGoToBoard() take the user. Therefore, this command should not be accessed in "inline mode".

doGoToSprintOnBoard

public java.lang.String doGoToSprintOnBoard()

Given a sprintId and a rapidViewId, this command will redirect the user to the location of that sprint on that Rapid Board.

Note: this is where the links in doGoToBoard() take the user. Therefore, this command should not be accessed in "inline mode".

isIssueRequest

public boolean isIssueRequest()

getIssueId

public java.lang.Long getIssueId()

setIssueId

public void setIssueId(java.lang.Long issueId)

getSprintId

public java.lang.Long getSprintId()

setSprintId

public void setSprintId(java.lang.Long sprintId)

getRapidViewId

public java.lang.Long getRapidViewId()

setRapidViewId

public void setRapidViewId(java.lang.Long rapidViewId)

getIssue

public com.atlassian.jira.issue.Issue getIssue()

getSprint

public Sprint getSprint()

getBoards

public java.util.List<RapidView> getBoards()

getNumBoards

public java.lang.Integer getNumBoards()