Package com.atlassian.jira.web.action.issue

Class AbstractCommentableIssue

java.lang.Object

webwork.action.ActionSupport

com.atlassian.jira.web.action.JiraWebActionSupport

com.atlassian.jira.web.action.ProjectActionSupport

com.atlassian.jira.web.action.IssueActionSupport

com.atlassian.jira.web.action.issue.AbstractIssueSelectAction

com.atlassian.jira.web.action.issue.AbstractViewIssue

com.atlassian.jira.web.action.issue.AbstractCommentableIssue

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCommentableAssignableIssue, AbstractIssueLinkAction, AbstractWorklogAction, AddComment, AttachFile, EditComment, ManageAttachments

public class AbstractCommentableIssue
extends AbstractViewIssue
implements OperationContext

This class should be extended by any action that modifies issues and can have an associated comment.

Subclasses should call super.doValidation() to check commenting permission.

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	Description
protected final UserUtil	userUtil

Fields inherited from class com.atlassian.jira.web.action.issue.AbstractIssueSelectAction

id, ISSUE_PERMISSION_ERROR, PREPOPULATED_ISSUE_OBJECT

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

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, log, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters, SECURITY_BREACH_RESULT

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	Description
AbstractCommentableIssue(SubTaskManager subTaskManager, FieldScreenRendererFactory fieldScreenRendererFactory, FieldManager fieldManager, ProjectRoleManager projectRoleManager, CommentService commentService, UserUtil userUtil)
AbstractCommentableIssue(SubTaskManager subTaskManager, FieldScreenRendererFactory fieldScreenRendererFactory, FieldManager fieldManager, ProjectRoleManager projectRoleManager, CommentService commentService, UserUtil userUtil, AttachmentHelper attachmentHelper)

Method Summary

Modifier and Type	Method	Description
protected Comment	createComment()
protected void	doCommentValidation(boolean allowEmptyComment)
String	doDefault()
protected void	doValidation()
String	getComment()
String	getCommentLevel()
Map<String,Object>	getDisplayParams()
FieldScreenRenderLayoutItem	getFieldScreenRendererLayoutItemForField(OrderableField field)
protected FieldScreenRenderer	getFieldScreenRendererWithAllFields()
Map<String,Object>	getFieldValuesHolder()
String	getGroupLevel()
Collection<com.atlassian.crowd.embedded.api.Group>	getGroupLevels()
IssueOperation	getIssueOperation()
protected OrderableField	getOrderableField(String fieldId)
Collection<ProjectRole>	getRoleLevels()
protected void	populateAttachmentsFieldValuesHolderAndValidate()
protected void	populateCommentFields()
protected void	processAttachments()
protected void	processAttachments(MutableIssue mutableIssue)
protected void	requireAttachmentsResources()
void	setComment(String comment)
void	setCommentLevel(String commentLevel)
void	setFieldValuesHolder(Map<String,Object> fieldValuesHolder)
void	setGroupLevel(String groupLevel)	Sets the name of the group to which comment visibility will be restricted.

Methods inherited from class com.atlassian.jira.web.action.issue.AbstractViewIssue

getAttachments, getPossibleComponents, getPossibleVersions, getPossibleVersionsReleasedFirst

Methods inherited from class com.atlassian.jira.web.action.issue.AbstractIssueSelectAction

addErrorMessage, assertIssueIsValid, cameFromIssue, cameFromParent, getId, getIssue, getIssueObject, getIssueObjectWithoutDatabaseRead, getIssuePath, getKey, getLayoutBean, getMutableIssue, getParentIssueObject, getProject, getProjectObject, getSecurityLevel, getSubTaskManager, getSummaryIssue, getViewIssueKey, getViewUrl, isEditable, isEditable, isHasEditIssuePermission, isIssueExists, isIssueValid, isSubTask, isSubTaskCreatable, isWorkflowAllowsEdit, redirectToView, refreshIssueObject, setId, setIssueObject, setKey, setViewIssueKey

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

addIssueToHistory, getAttachmentManager, getCurrentDateTimeInUsersTimezone, getCurrentFailedLoginCount, getCurrentJQL, getCustomFieldManager, getDaysPerWeek, getEverLoggedIn, getFormToken, getHoursPerDay, getIssueManager, getLastFailedLogin, getLastLogin, getLoginCount, getPossibleVersions, getPossibleVersionsReleasedFirst, getPrettyDuration, getPreviousLogin, getSearchRequest, getSelectedIssueId, getSessionPagerFilterManager, getSessionSearchRequestManager, getSessionSearchRequestManagerFactory, getSessionSelectedIssueManager, getTotalFailedLoginCount, getUrlEncoded, getWorkflow, getWorkflowTransitionDescription, getWorkflowTransitionDisplayName, isCustomFieldHidden, isElevatedSecurityCheckRequired, isFieldHidden, isFieldHidden, isTimeTrackingEnabled, setFormToken, setSearchRequest, setSelectedIssueId, 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, addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, addMessageToResponse, addReason, addReasons, checkIfUrlIsAllowed, execute, forceRedirect, getActionName, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getComponentInstanceOfType, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDefaultResourceBundle, getDescTranslation, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getI18nHelper, getJiraContactHelper, getJiraServiceContext, getKeysForPrefix, getLanguage, getLocale, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getNameTranslation, getOfBizDelegator, getOutboundWhitelistProvider, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getRequestSourceType, getResourceBundle, getResult, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTimeFormat, getUnescapedText, getUntransformedRawText, getUriValidator, getUserFullName, getUserManager, getUserPreferences, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasAnyErrors, hasErrorMessage, hasErrorMessageByKey, hasGlobalPermission, hasGlobalPermission, hasIssuePermission, hasIssuePermission, hasIssuePermission, hasPermission, hasProjectPermission, hasProjectPermission, htmlEncode, insertContextPath, isAdministrator, isIndexing, isInlineDialogMode, isKeyDefined, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, removeKeyOrAddError, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, tagMauEventWithApplication, tagMauEventWithProject, urlEncode

Methods inherited from class webwork.action.ActionSupport

addError, doExecute, 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 webwork.action.CommandDriven

getCommandName, setCommand

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

addError, setErrorMessages

Methods inherited from interface com.atlassian.jira.web.action.issue.IssueSummaryAware

getLoggedInApplicationUser

Field Details

userUtil

protected final transient UserUtil userUtil

Constructor Details

AbstractCommentableIssue

public AbstractCommentableIssue(SubTaskManager subTaskManager,
 FieldScreenRendererFactory fieldScreenRendererFactory,
 FieldManager fieldManager,
 ProjectRoleManager projectRoleManager,
 CommentService commentService,
 UserUtil userUtil,
 AttachmentHelper attachmentHelper)

AbstractCommentableIssue

public AbstractCommentableIssue(SubTaskManager subTaskManager,
 FieldScreenRendererFactory fieldScreenRendererFactory,
 FieldManager fieldManager,
 ProjectRoleManager projectRoleManager,
 CommentService commentService,
 UserUtil userUtil)

Method Details

doDefault

public String doDefault()
                 throws Exception

Overrides:

doDefault in class webwork.action.ActionSupport

Throws:

Exception

doValidation

protected void doValidation()

Overrides:

doValidation in class webwork.action.ActionSupport

doCommentValidation

protected void doCommentValidation(boolean allowEmptyComment)

populateCommentFields

protected void populateCommentFields()

createComment

@Nullable
protected Comment createComment()

getComment

public String getComment()

setComment

public void setComment(String comment)

getCommentLevel

public String getCommentLevel()

setCommentLevel

public void setCommentLevel(String commentLevel)

getGroupLevel

public String getGroupLevel()

Returns:

the name of the group to which comment visibility will be restricted.

setGroupLevel

public void setGroupLevel(String groupLevel)

Sets the name of the group to which comment visibility will be restricted.

Parameters:

groupLevel - a group name.

getGroupLevels

public Collection<com.atlassian.crowd.embedded.api.Group> getGroupLevels()

getRoleLevels

public Collection<ProjectRole> getRoleLevels()

getFieldValuesHolder

public Map<String,Object> getFieldValuesHolder()

Specified by:

getFieldValuesHolder in interface OperationContext

getIssueOperation

public IssueOperation getIssueOperation()

Specified by:

getIssueOperation in interface OperationContext

setFieldValuesHolder

public void setFieldValuesHolder(Map<String,Object> fieldValuesHolder)

getFieldScreenRendererLayoutItemForField

public FieldScreenRenderLayoutItem getFieldScreenRendererLayoutItemForField(OrderableField field)

getDisplayParams

public Map<String,Object> getDisplayParams()

getFieldScreenRendererWithAllFields

protected FieldScreenRenderer getFieldScreenRendererWithAllFields()

getOrderableField

protected OrderableField getOrderableField(String fieldId)

requireAttachmentsResources

protected void requireAttachmentsResources()

populateAttachmentsFieldValuesHolderAndValidate

protected void populateAttachmentsFieldValuesHolderAndValidate()

processAttachments

protected void processAttachments()

processAttachments

protected void processAttachments(MutableIssue mutableIssue)