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

Class AbstractWorklogAction

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

com.atlassian.jira.web.action.issue.AbstractWorklogAction

All Implemented Interfaces:

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

Direct Known Subclasses:

CreateWorklog, DeleteWorklog, UpdateWorklog

public abstract class AbstractWorklogAction
extends AbstractCommentableIssue

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 static final String	ADJUST_ESTIMATE_AUTO
protected static final String	ADJUST_ESTIMATE_MANUAL
protected static final String	ADJUST_ESTIMATE_NEW
protected String	adjustEstimate
protected final CommentService	commentService
protected final DateTimeFormatterFactory	dateTimeFormatterFactory
protected final FieldLayoutManager	fieldLayoutManager
protected final FieldVisibilityManager	fieldVisibilityManager
protected final JiraDurationUtils	jiraDurationUtils
protected final ProjectRoleManager	projectRoleManager
protected final WorklogService	worklogService

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

AbstractWorklogAction(WorklogService worklogService, CommentService commentService, ProjectRoleManager projectRoleManager, JiraDurationUtils jiraDurationUtils, FieldVisibilityManager fieldVisibilityManager, FieldLayoutManager fieldLayoutManager, RendererManager rendererManager, UserUtil userUtil, DateTimeFormatterFactory dateTimeFormatterFactory, SubTaskManager subTaskManager, FieldScreenRendererFactory fieldScreenRendererFactory, FieldManager fieldManager, AttachmentHelper attachmentHelper, MentionService mentionService, JiraLicenseService jiraLicenseService)

Method Summary

Modifier and Type	Method	Description
String	getAdjustEstimate()
String	getAdjustmentAmount()
String	getComment()
String	getCommentLevel()
protected CommentVisibility	getCommentVisibility()
boolean	getDisplayMarketplaceLink()
String	getEstimate()
protected String	getFormattedStartDate(Date date)
Collection	getGroupLevels()
String	getNewEstimate()
protected Date	getParsedStartDate()
String	getRendererType()
Collection<ProjectRole>	getRoleLevels()
String	getSelectedLevelName()
String	getStartDate()
String	getTimeLogged()
String	getWorkDescriptionEditHtml()	Renders the input control for the Work Description (i.e.
Long	getWorklogId()
String	getWorkType()
boolean	isLevelSelected(String visibilityLevel)
boolean	isOnDemand()	Deprecated.
boolean	isTimeTrackingFieldHidden(Issue issue)
void	setAdjustEstimate(String adjustEstimate)
void	setAdjustmentAmount(String adjustmentAmount)
void	setComment(String comment)
void	setCommentLevel(String commentLevel)
void	setNewEstimate(String newEstimate)
void	setStartDate(String startDate)
void	setTimeLogged(String timeLogged)
void	setWorklogId(Long worklogId)
void	setWorkType(String workType)

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

createComment, doCommentValidation, doDefault, doValidation, getDisplayParams, getFieldScreenRendererLayoutItemForField, getFieldScreenRendererWithAllFields, getFieldValuesHolder, getGroupLevel, getIssueOperation, getOrderableField, populateAttachmentsFieldValuesHolderAndValidate, populateCommentFields, processAttachments, processAttachments, requireAttachmentsResources, setFieldValuesHolder, setGroupLevel

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

ADJUST_ESTIMATE_AUTO

protected static final String ADJUST_ESTIMATE_AUTO

See Also:

• Constant Field Values

ADJUST_ESTIMATE_NEW

protected static final String ADJUST_ESTIMATE_NEW

See Also:

• Constant Field Values

ADJUST_ESTIMATE_MANUAL

protected static final String ADJUST_ESTIMATE_MANUAL

See Also:

• Constant Field Values

adjustEstimate

protected String adjustEstimate

worklogService

protected final WorklogService worklogService

commentService

protected final CommentService commentService

projectRoleManager

protected final ProjectRoleManager projectRoleManager

jiraDurationUtils

protected final JiraDurationUtils jiraDurationUtils

dateTimeFormatterFactory

protected final DateTimeFormatterFactory dateTimeFormatterFactory

fieldVisibilityManager

protected final FieldVisibilityManager fieldVisibilityManager

fieldLayoutManager

protected final FieldLayoutManager fieldLayoutManager

Constructor Details

AbstractWorklogAction

public AbstractWorklogAction(WorklogService worklogService,
 CommentService commentService,
 ProjectRoleManager projectRoleManager,
 JiraDurationUtils jiraDurationUtils,
 FieldVisibilityManager fieldVisibilityManager,
 FieldLayoutManager fieldLayoutManager,
 RendererManager rendererManager,
 UserUtil userUtil,
 DateTimeFormatterFactory dateTimeFormatterFactory,
 SubTaskManager subTaskManager,
 FieldScreenRendererFactory fieldScreenRendererFactory,
 FieldManager fieldManager,
 AttachmentHelper attachmentHelper,
 MentionService mentionService,
 JiraLicenseService jiraLicenseService)

Method Details

getComment

public String getComment()

Overrides:

getComment in class AbstractCommentableIssue

getEstimate

public String getEstimate()
                   throws Exception

Throws:

Exception

isTimeTrackingFieldHidden

public boolean isTimeTrackingFieldHidden(Issue issue)

getTimeLogged

public String getTimeLogged()

setTimeLogged

public void setTimeLogged(String timeLogged)

getWorkType

public String getWorkType()

setWorkType

public void setWorkType(String workType)

getNewEstimate

public String getNewEstimate()

setNewEstimate

public void setNewEstimate(String newEstimate)

getAdjustmentAmount

public String getAdjustmentAmount()

setAdjustmentAmount

public void setAdjustmentAmount(String adjustmentAmount)

getAdjustEstimate

public String getAdjustEstimate()

setAdjustEstimate

public void setAdjustEstimate(String adjustEstimate)

isLevelSelected

public boolean isLevelSelected(String visibilityLevel)

getSelectedLevelName

public String getSelectedLevelName()

getCommentLevel

public String getCommentLevel()

Overrides:

getCommentLevel in class AbstractCommentableIssue

setCommentLevel

public void setCommentLevel(String commentLevel)

Overrides:

setCommentLevel in class AbstractCommentableIssue

setComment

public void setComment(String comment)

Overrides:

setComment in class AbstractCommentableIssue

getGroupLevels

public Collection getGroupLevels()

Overrides:

getGroupLevels in class AbstractCommentableIssue

getRoleLevels

public Collection<ProjectRole> getRoleLevels()

Overrides:

getRoleLevels in class AbstractCommentableIssue

getStartDate

public String getStartDate()

setStartDate

public void setStartDate(String startDate)

getCommentVisibility

protected CommentVisibility getCommentVisibility()

getParsedStartDate

protected Date getParsedStartDate()

getFormattedStartDate

protected String getFormattedStartDate(Date date)

getWorklogId

public Long getWorklogId()

setWorklogId

public void setWorklogId(Long worklogId)

getWorkDescriptionEditHtml

public String getWorkDescriptionEditHtml()

Renders the input control for the Work Description (i.e. Comment) of the Log Work form. The control will be different depending on which renderer is chosen for the Log Work field for this specific issue context.

Returns:

the HTML of the input control to be displayed on the form.

getRendererType

public String getRendererType()

getDisplayMarketplaceLink

public boolean getDisplayMarketplaceLink()

isOnDemand

@Deprecated
public boolean isOnDemand()

Deprecated.