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

java.lang.Object
  extended by webwork.action.ActionSupport
      extended by com.atlassian.jira.action.JiraActionSupport
          extended by com.atlassian.jira.web.action.JiraWebActionSupport
              extended by com.atlassian.jira.web.action.ProjectActionSupport
                  extended by com.atlassian.jira.web.action.IssueActionSupport
                      extended by com.atlassian.jira.web.action.issue.AbstractIssueSelectAction
                          extended by com.atlassian.jira.web.action.issue.AbstractViewIssue
                              extended by 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, AddComment, AttachFile, AttachScreenshot, 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
protected  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, 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
AbstractCommentableIssue(SubTaskManager subTaskManager, FieldScreenRendererFactory fieldScreenRendererFactory, FieldManager fieldManager, ProjectRoleManager projectRoleManager, CommentService commentService, UserUtil userUtil)
           
 
Method Summary
protected  Comment createComment()
           
protected  void doCommentValidation(boolean allowEmptyComment)
           
protected  void doValidation()
           
 String getComment()
           
 String getCommentLevel()
           
 Map<String,Object> getDisplayParams()
           
 FieldScreenRenderLayoutItem getFieldScreenRendererLayoutItemForField(OrderableField field)
           
protected  FieldScreenRenderer getFieldScreenRendererWithAllFields()
           
 Map getFieldValuesHolder()
           
 String getGroupLevel()
           
 Collection<com.atlassian.crowd.embedded.api.Group> getGroupLevels()
           
 IssueOperation getIssueOperation()
           
protected  OrderableField getOrderableField(String fieldId)
           
 Collection<ProjectRole> getRoleLevels()
           
protected  void populateCommentFields()
           
 void setComment(String comment)
           
 void setCommentLevel(String commentLevel)
           
 void setFieldValuesHolder(Map fieldValuesHolder)
           
 void setGroupLevel(String groupLevel)
           
 
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, getParentIssueObject, getProject, 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, clearSelectedIssue, getAttachmentManager, getCurrentFailedLoginCount, getCurrentJQL, getCustomFieldManager, getDaysPerWeek, getEverLoggedIn, 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, setSearchRequest, setSelectedIssueId, updateSearchRequest
 
Methods inherited from class com.atlassian.jira.web.action.ProjectActionSupport
getBrowsableProjects, getBrowseableProjects, 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, getDmyDateFormatter, getEmptyResponse, 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, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getUnescapedText, getUntransformedRawText, getUserPreferences, getWatcherManager, hasAnyErrors, isIndexing, isKeyDefined, removeKeyOrAddError
 
Methods inherited from class webwork.action.ActionSupport
addError, doDefault, 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 com.atlassian.jira.web.action.issue.IssueSummaryAware
getLoggedInUser
 
Methods inherited from interface com.atlassian.jira.util.ErrorCollection
addError, addErrorMessages, addErrors, hasAnyErrors, setErrorMessages
 
Methods inherited from interface webwork.action.CommandDriven
getCommandName, setCommand
 

Field Detail

userUtil

protected final transient UserUtil userUtil
Constructor Detail

AbstractCommentableIssue

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

doValidation

protected void doValidation()
Overrides:
doValidation in class webwork.action.ActionSupport

doCommentValidation

protected void doCommentValidation(boolean allowEmptyComment)

populateCommentFields

protected void populateCommentFields()

createComment

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)
Parameters:
groupLevel -

getGroupLevels

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

getRoleLevels

public Collection<ProjectRole> getRoleLevels()

getFieldValuesHolder

public Map getFieldValuesHolder()
Specified by:
getFieldValuesHolder in interface OperationContext

getIssueOperation

public IssueOperation getIssueOperation()
Specified by:
getIssueOperation in interface OperationContext

setFieldValuesHolder

public void setFieldValuesHolder(Map fieldValuesHolder)

getFieldScreenRendererLayoutItemForField

public FieldScreenRenderLayoutItem getFieldScreenRendererLayoutItemForField(OrderableField field)

getDisplayParams

public Map<String,Object> getDisplayParams()

getFieldScreenRendererWithAllFields

protected FieldScreenRenderer getFieldScreenRendererWithAllFields()

getOrderableField

protected OrderableField getOrderableField(String fieldId)


Copyright © 2002-2013 Atlassian. All Rights Reserved.