com.atlassian.jira.web.action

Class IssueActionSupport

java.lang.Object

webwork.action.ActionSupport

com.atlassian.jira.action.JiraActionSupport

com.atlassian.jira.web.action.JiraWebActionSupport

com.atlassian.jira.web.action.ProjectActionSupport

com.atlassian.jira.web.action.IssueActionSupport

All Implemented Interfaces:

ErrorCollection, I18nHelper, HttpServletVariables, AuthorizationSupport, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

Direct Known Subclasses:

AbstractBrowser, AbstractBulkOperationAction, AbstractIssueSelectAction, AbstractPluggableTabPanelAction, ArchiveProject, DeleteGroup, DeleteProject, SearchDescriptionEnabledAction, ViewUser

public class IssueActionSupport
extends ProjectActionSupport

See Also:

Serialized Form

Nested Class Summary

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

JiraWebActionSupport.MessageType

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

ErrorCollection.Reason

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

I18nHelper.BeanFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected AttachmentManager	attachmentManager

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

projectManager

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

ISSUE_NOT_FOUND_RESULT, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters, SECURITY_BREACH_RESULT

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

Constructors

Constructor and Description
IssueActionSupport()
IssueActionSupport(IssueManager issueManager, CustomFieldManager customFieldManager, AttachmentManager attachmentManager, ProjectManager projectManager, PermissionManager permissionManager, VersionManager versionManager, UserIssueHistoryManager userHistoryManager, TimeTrackingConfiguration timeTrackingConfiguration)

Method Summary

Modifier and Type	Method and Description
void	addIssueToHistory(Issue issueObj) Sets the current issue.
AttachmentManager	getAttachmentManager()
String	getCurrentDateTimeInUsersTimezone() This method returns YYYY/MM/dd HH:mm:ss string for logged in user using English locale.
String	getCurrentFailedLoginCount(ApplicationUser user) This can be called to get a the number of times the user currently failed to logged in
String	getCurrentJQL() Deprecated. Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.
CustomFieldManager	getCustomFieldManager()
BigDecimal	getDaysPerWeek()
boolean	getEverLoggedIn(ApplicationUser user) True if the user has ever logged in to JIRA
String	getFormToken()
BigDecimal	getHoursPerDay()
IssueManager	getIssueManager()
String	getLastFailedLogin(ApplicationUser user) This can be called to get a description of the last time the user failed to logged in
String	getLastLogin(ApplicationUser user) This can be called to get a description of the last time the user logged in
String	getLoginCount(ApplicationUser user) This can be called to get a the number of times the user logged in
List<VersionProxy>	getPossibleVersions(Project project) Returns a list of versions applicable to this issue (unreleased first).
List<VersionProxy>	getPossibleVersionsReleasedFirst(Project project) Returns a list of versions applicable to this issue (released first).
String	getPrettyDuration(Long v) this formatting function is shared by the full view for navigator as well as view issue.
String	getPreviousLogin(ApplicationUser user) This can be called to get a description of the second last time the user logged in
SearchRequest	getSearchRequest() Deprecated. Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.
Long	getSelectedIssueId() Deprecated. Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.
protected SessionPagerFilterManager	getSessionPagerFilterManager() Deprecated. Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.
protected SessionSearchRequestManager	getSessionSearchRequestManager() Deprecated. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0. Since 7.1
SessionSearchObjectManagerFactory	getSessionSearchRequestManagerFactory() Deprecated. Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.
protected SessionSelectedIssueManager	getSessionSelectedIssueManager() Deprecated. Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.
String	getTotalFailedLoginCount(ApplicationUser user) This can be called to get a the total number of times the user has failed to logged in
String	getUrlEncoded(String s)
com.opensymphony.workflow.Workflow	getWorkflow()
String	getWorkflowTransitionDescription(com.opensymphony.workflow.loader.ActionDescriptor descriptor)
String	getWorkflowTransitionDisplayName(com.opensymphony.workflow.loader.ActionDescriptor descriptor) Get the i18n'ed name of a workflow action (eg.
boolean	isCustomFieldHidden(Long projectId, Long customFieldId, String issueTypeId) Deprecated. Use FieldVisibilityManager.isCustomFieldHidden(java.lang.Long, java.lang.Long, java.lang.String) instead.
boolean	isElevatedSecurityCheckRequired(ApplicationUser user) True if the user requires an elevated security check on the next login
boolean	isFieldHidden(Long projectId, String id, Integer issueTypeId)
boolean	isFieldHidden(Long projectId, String id, String issueTypeId) Deprecated. Use FieldVisibilityManager.isFieldHidden(java.lang.Long, java.lang.String, java.lang.String) instead.
boolean	isTimeTrackingEnabled()
void	setFormToken(String formToken)
protected void	setSearchRequest(SearchRequest searchRequest) Deprecated. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0. Since 7.1
void	setSelectedIssueId(Long selectedIssueId) Deprecated. Use SessionSearchObjectManager.setCurrentObject(Object) instead
protected void	updateSearchRequest()

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

getBrowsableProjects, getSelectedProjectId, setSelectedProject, setSelectedProject

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, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getJiraContactHelper, getJiraServiceContext, getLanguage, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getRequestSourceType, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getTimeFormat, getUriValidator, getUserFullName, getUserManager, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, hasGlobalPermission, hasGlobalPermission, hasIssuePermission, hasIssuePermission, hasIssuePermission, hasPermission, hasProjectPermission, hasProjectPermission, htmlEncode, insertContextPath, isInlineDialogMode, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, tagMauEventWithApplication, tagMauEventWithProject, urlEncode

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

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

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doDefault, doExecute, doValidation, getCommandName, 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

getCommandName, setCommand

Field Detail

attachmentManager

protected final AttachmentManager attachmentManager

Constructor Detail

IssueActionSupport

public IssueActionSupport(IssueManager issueManager,
                          CustomFieldManager customFieldManager,
                          AttachmentManager attachmentManager,
                          ProjectManager projectManager,
                          PermissionManager permissionManager,
                          VersionManager versionManager,
                          UserIssueHistoryManager userHistoryManager,
                          TimeTrackingConfiguration timeTrackingConfiguration)

IssueActionSupport

public IssueActionSupport()

Method Detail

getIssueManager

public IssueManager getIssueManager()

getCustomFieldManager

public CustomFieldManager getCustomFieldManager()

getAttachmentManager

public AttachmentManager getAttachmentManager()

getSearchRequest

@Deprecated
public SearchRequest getSearchRequest()

Deprecated. Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.

This method will return the one in the current search request, or return null if one does not exist

getCurrentJQL

@Deprecated
public String getCurrentJQL()

Deprecated. Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.

Reutrns the JQL representation of the curren search erquest in the session.

Returns:

the jql of the SearchRequest in the session, empty string otherwise.

setSearchRequest

@Deprecated
protected void setSearchRequest(SearchRequest searchRequest)

Deprecated. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0. Since 7.1

This method set the SearchRequest in the user's session

Parameters:

searchRequest - The seerachRequest to place in the session

getSessionSearchRequestManager

@Deprecated
protected SessionSearchRequestManager getSessionSearchRequestManager()

Deprecated. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0. Since 7.1

getSessionSelectedIssueManager

@Deprecated
protected SessionSelectedIssueManager getSessionSelectedIssueManager()

Deprecated. Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.

getSessionPagerFilterManager

@Deprecated
protected SessionPagerFilterManager getSessionPagerFilterManager()

Deprecated. Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.

getSessionSearchRequestManagerFactory

@Deprecated
public SessionSearchObjectManagerFactory getSessionSearchRequestManagerFactory()

Deprecated. Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.

updateSearchRequest

protected void updateSearchRequest()

addIssueToHistory

public void addIssueToHistory(Issue issueObj)

Sets the current issue. This is similar to setting the current project - so that we can make things more convenient for users.

Parameters:

issueObj - The issue that you are currently viewing.

getPossibleVersions

public List<VersionProxy> getPossibleVersions(Project project)
                                       throws Exception

Returns a list of versions applicable to this issue (unreleased first).

Throws:

Exception

getPossibleVersionsReleasedFirst

public List<VersionProxy> getPossibleVersionsReleasedFirst(Project project)
                                                    throws Exception

Returns a list of versions applicable to this issue (released first).

Throws:

Exception

getUrlEncoded

public String getUrlEncoded(String s)

getWorkflow

public com.opensymphony.workflow.Workflow getWorkflow()

getHoursPerDay

public BigDecimal getHoursPerDay()

getDaysPerWeek

public BigDecimal getDaysPerWeek()

isTimeTrackingEnabled

public boolean isTimeTrackingEnabled()

getPrettyDuration

public String getPrettyDuration(Long v)

this formatting function is shared by the full view for navigator as well as view issue.

Parameters:

v - duration in seconds

setSelectedIssueId

@Deprecated
public void setSelectedIssueId(Long selectedIssueId)

Deprecated. Use SessionSearchObjectManager.setCurrentObject(Object) instead

Since v4.2 this method invocation does nothing

Parameters:

selectedIssueId - id of the currently saelected issue

getSelectedIssueId

@Deprecated
public Long getSelectedIssueId()

Deprecated. Since 7.1. Storing information on the httpsession is obsoleted. Please move this functionality to the frontend or other type of storage. This method will be removed in 8.0.

isCustomFieldHidden

@Deprecated
public boolean isCustomFieldHidden(Long projectId,
                                               Long customFieldId,
                                               String issueTypeId)

Deprecated. Use FieldVisibilityManager.isCustomFieldHidden(java.lang.Long, java.lang.Long, java.lang.String) instead.

Checks if the custom field is hidden in the project with id of projectId.

Parameters:

projectId -

customFieldId - the data store id of the custom field

isFieldHidden

@Deprecated
public boolean isFieldHidden(Long projectId,
                                         String id,
                                         String issueTypeId)

Deprecated. Use FieldVisibilityManager.isFieldHidden(java.lang.Long, java.lang.String, java.lang.String) instead.

Checks if the field is hidden in the project with id of projectId.

Parameters:

projectId -

id - fieldId

isFieldHidden

public boolean isFieldHidden(Long projectId,
                             String id,
                             Integer issueTypeId)

getWorkflowTransitionDisplayName

public String getWorkflowTransitionDisplayName(com.opensymphony.workflow.loader.ActionDescriptor descriptor)

Get the i18n'ed name of a workflow action (eg. 'Start Progress').

Parameters:

descriptor - Descriptor eg. from JiraWorkflow.getDescriptor()

getWorkflowTransitionDescription

public String getWorkflowTransitionDescription(com.opensymphony.workflow.loader.ActionDescriptor descriptor)

getLastLogin

public String getLastLogin(ApplicationUser user)

This can be called to get a description of the last time the user logged in

Parameters:

user - the user in play (not the current user but any user)

Returns:

a string of their last login time or a not recorded message

getPreviousLogin

public String getPreviousLogin(ApplicationUser user)

This can be called to get a description of the second last time the user logged in

Parameters:

user - the user in play (not the current user but any user)

Returns:

a string of their last login time or a not recorded message

getLastFailedLogin

public String getLastFailedLogin(ApplicationUser user)

This can be called to get a description of the last time the user failed to logged in

Parameters:

user - the user in play (not the current user but any user)

Returns:

a string of their last failed login time or a not recorded message

getLoginCount

public String getLoginCount(ApplicationUser user)

This can be called to get a the number of times the user logged in

Parameters:

user - the user in play (not the current user but any user)

Returns:

a string of their number of times they have logged in or a not recorded message

getCurrentFailedLoginCount

public String getCurrentFailedLoginCount(ApplicationUser user)

This can be called to get a the number of times the user currently failed to logged in

Parameters:

user - the user in play (not the current user but any user)

Returns:

a string of their number of times they have currently failed to logged in or a not recorded message

getTotalFailedLoginCount

public String getTotalFailedLoginCount(ApplicationUser user)

This can be called to get a the total number of times the user has failed to logged in

Parameters:

user - the user in play (not the current user but any user)

Returns:

a string of their total number of times they have failed to logged in or a not recorded message

isElevatedSecurityCheckRequired

public boolean isElevatedSecurityCheckRequired(ApplicationUser user)

True if the user requires an elevated security check on the next login

Parameters:

user - the user in play (not the current user but any user)

Returns:

true if the user requires an elevated security check on the next login

getEverLoggedIn

public boolean getEverLoggedIn(ApplicationUser user)

True if the user has ever logged in to JIRA

Parameters:

user - the user in play (not the current user but any user)

Returns:

true if they have ever logged into JIRA

getFormToken

public String getFormToken()

setFormToken

public void setFormToken(String formToken)

getCurrentDateTimeInUsersTimezone

public String getCurrentDateTimeInUsersTimezone()

This method returns YYYY/MM/dd HH:mm:ss string for logged in user using English locale. This date-time format is safe to be parsed on all versions of Chrome, Firefox and IE. The date is the current date-time of the logged in user as per timezone configured in that user's profile. It should be used to initialise both date-only and date-time fields.

Returns:

current date-time for logged in user.