java.lang.Object
   ↳ com.atlassian.jira.issue.fields.AbstractField
     ↳ com.atlassian.jira.issue.fields.AbstractOrderableField
       ↳ com.atlassian.jira.issue.fields.WorklogSystemField

Class Overview

A field representation of logging work.

This allows JIRA administrators to place the "Log Work" field on screens. This means that JIRA users can now log work whilst creating, editing or transitioning issues. The field works in a similar way to the CommentSystemField in that while it implements the "getEditHtml" method, previously entered work logs cannot be edited. In effect, the only functionality available is to "add" more work logs.

The WorklogService is used to do the hard work of validating and creating the work logs from user input.

See Also

Summary

Nested Classes
interface WorklogSystemField.WorklogValue A value object used to aggregate all the transient values required in taking input from the UI, validating it and creating the resultant work logs. 
Constants
String PARAM_ISCREATEISSUE
String PARAM_ISDELETELOG
String PARAM_ISEDITLOG
String WORKLOG_ACTIVATE
String WORKLOG_ADJUSTESTIMATE
String WORKLOG_ADJUSTMENTAMOUNT
String WORKLOG_DESCRIPTION
String WORKLOG_ID
String WORKLOG_NEWESTIMATE
String WORKLOG_STARTDATE
String WORKLOG_TIMELOGGED
String WORKLOG_VISIBILITY_LEVEL
[Expand]
Inherited Constants
From interface com.atlassian.jira.issue.fields.OrderableField
[Expand]
Inherited Fields
From class com.atlassian.jira.issue.fields.AbstractField
Public Constructors
WorklogSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, CommentSearchHandlerFactory searchHandlerFactory, ComponentLocator componentLocator, GroupManager groupManager, DateTimeFormatterFactory dateTimeFormatterFactory, JiraBaseUrls jiraBaseUrls, EmailFormatter emailFormatter)
Public Methods
String availableForBulkEdit(BulkEditBean bulkEditBean)
Determines whether the field is available for bulk editing given the BulkEditBean.
boolean canRemoveValueFromIssueObject(Issue issue)
Returns true if a call to removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue) will actually remove the value.
SearchHandler createAssociatedSearchHandler()
Return SearchHandler for the field.
void createValue(Issue issue, Object newValue)
Create the value of the issue in the data store.
String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, Action action, Issue issue, Map displayParameters)
Returns the HTML that should be shown when the issue is being created.
Object getDefaultValue(Issue issue)
The value that should be set on the issue if the field is not shown for some reason.
String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, Action action, Issue issue, Map displayParameters)
Returns HTML that should be shown when the issue is being edited.
FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)
Returns lower level Information about the field.
JsonData getJsonDefaultValue(IssueContext issueCtx)
Return The default data for this system field.
FieldJsonRepresentation getJsonFromIssue(Issue issue, boolean renderedVersionRequested, FieldLayoutItem fieldLayoutItem)
Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.
JsonType getJsonSchema()
Return a description of the shape of this field when represented as JSON.
RestFieldOperationsHandler getRestFieldOperation()
String getValueFromIssue(Issue issue)
Gets the value stored for this field on the provided issue.
Object getValueFromParams(Map params)
Get a field value from the map of parameters passed.
String getViewHtml(FieldLayoutItem fieldLayoutItem, Action action, Issue issue, Map displayParameters)
String getViewHtml(FieldLayoutItem fieldLayoutItem, Action action, Issue issue, Object value, Map displayParameters)
boolean hasValue(Issue issue)
Determines if the field has a value for the given issue.
boolean isRenderable()
Defines if a field determines itself as renderable.
boolean isShown(Issue issue)
Tests field specific way to determine if it should be shown or not.
MessagedResult needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem)
Used to determine if the field needs input from user to be moved to the new project and/or issue type.
void populateDefaults(Map<String, Object> fieldValuesHolder, Issue issue)
Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet.
void populateForMove(Map<String, Object> fieldValuesHolder, Issue originalIssue, Issue targetIssue)
Used to populate the fieldValueHolder with parameters for move issue screen.
void populateFromIssue(Map<String, Object> fieldValuesHolder, Issue issue)
Used to initialise the fieldValuesHolder from the current value of teh issue.
void populateParamsFromString(Map<String, Object> fieldValuesHolder, String stringValue, Issue issue)
Used to convert from a user friendly string value and put the result into the fieldValuesHolder.
void removeValueFromIssueObject(MutableIssue issue)
Removes the field value from the given MutableIssue object.
void setLoggedInUser(ApplicationUser loggedInUser)
Explicitly set current session
void updateIssue(FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder)
Sets the value as a modified external field in the issue so that this field will be updated along with all the other modified issue values.
void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder)
Update the issue in the data store.
void validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
Ensure that the parameters are valid
Protected Methods
Object getRelevantParams(Map<String, String[]> inputParameters)
Defines the object that will be passed through to the create method
[Expand]
Inherited Methods
From class com.atlassian.jira.issue.fields.AbstractOrderableField
From class com.atlassian.jira.issue.fields.AbstractField
From class java.lang.Object
From interface com.atlassian.jira.issue.fields.Field
From interface com.atlassian.jira.issue.fields.OrderableField
From interface com.atlassian.jira.issue.fields.SearchableField
From interface com.atlassian.jira.issue.fields.renderer.RenderableField
From interface com.atlassian.jira.issue.fields.rest.AuthAwareField
From interface com.atlassian.jira.issue.fields.rest.RestAwareField
From interface com.atlassian.jira.issue.fields.rest.RestFieldOperations
From interface java.lang.Comparable

Constants

public static final String PARAM_ISCREATEISSUE

Constant Value: "isCreateIssue"

public static final String PARAM_ISDELETELOG

Constant Value: "isDeleteLog"

public static final String PARAM_ISEDITLOG

Constant Value: "isEditLog"

public static final String WORKLOG_ACTIVATE

Constant Value: "worklog_activate"

public static final String WORKLOG_ADJUSTESTIMATE

Constant Value: "worklog_adjustEstimate"

public static final String WORKLOG_ADJUSTMENTAMOUNT

Constant Value: "worklog_adjustmentAmount"

public static final String WORKLOG_DESCRIPTION

Constant Value: "worklog_description"

public static final String WORKLOG_ID

Constant Value: "worklog_id"

public static final String WORKLOG_NEWESTIMATE

Constant Value: "worklog_newEstimate"

public static final String WORKLOG_STARTDATE

Constant Value: "worklog_startDate"

public static final String WORKLOG_TIMELOGGED

Constant Value: "worklog_timeLogged"

public static final String WORKLOG_VISIBILITY_LEVEL

Constant Value: "worklog_visibilityLevel"

Public Constructors

public WorklogSystemField (VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, CommentSearchHandlerFactory searchHandlerFactory, ComponentLocator componentLocator, GroupManager groupManager, DateTimeFormatterFactory dateTimeFormatterFactory, JiraBaseUrls jiraBaseUrls, EmailFormatter emailFormatter)

Public Methods

public String availableForBulkEdit (BulkEditBean bulkEditBean)

Determines whether the field is available for bulk editing given the BulkEditBean.

Parameters
bulkEditBean holds the state of the bulk-edit wizard (e.g. the selected issues for bulk editing)
Returns
  • null if the field is available for bulk-editing or an i18n key of the error message to show as why the field is not available.

public boolean canRemoveValueFromIssueObject (Issue issue)

Returns true if a call to removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue) will actually remove the value.

There a few different reasons why this method may return false:

  • The OrderableField can sometimes remove the value, but it decides that it is not relevant for this Issue. eg: Security Level will ignore remove requests on a subtask, as the subtask Security is not set explicitly (it is always inherited from its parent issue).
  • It may possible to remove this value, but the OrderableField does not actually do the job, it is done through some special mechanism. eg Attachments.
  • This field is some special system field which it is invalid to remove. eg Project. In these cases calling removeValueFromIssueObject() would normally raise an UnsupportedOperationException.
In general it is safe to call removeValueFromIssueObject() even if this method returns false, as the request will be silently ignored. However there are a couple of special fields where calling removeValueFromIssueObject() will throw an UnsupportedOperationException - eg if you try to remove the Project.

Parameters
issue The Issue object.
Returns

public SearchHandler createAssociatedSearchHandler ()

Return SearchHandler for the field. This object tells JIRA how to search for values within the field.

Returns
  • the SearchHandler associated with the field. Can return null when no searcher is associated with the field. This will mainly happen when a customfield is configured to have no searcher.

public void createValue (Issue issue, Object newValue)

Create the value of the issue in the data store.

Parameters
issue Issue this field is part of
newValue Value to store in this field (eg. Collection for Version fields). Cannot be null.

public String getCreateHtml (FieldLayoutItem fieldLayoutItem, OperationContext operationContext, Action action, Issue issue, Map displayParameters)

Returns the HTML that should be shown when the issue is being created.

Parameters
fieldLayoutItem FieldLayoutItem
operationContext OperationContext
action Action
issue Issue
displayParameters Map of display parameters.
Returns
  • the HTML that should be shown when the issue is being created.

public Object getDefaultValue (Issue issue)

The value that should be set on the issue if the field is not shown for some reason.

For example: The user does not have permission to see the field, or the field is not part of the create screen.

Parameters
issue the Issue.
Returns
  • The default Value.

public String getEditHtml (FieldLayoutItem fieldLayoutItem, OperationContext operationContext, Action action, Issue issue, Map displayParameters)

Returns HTML that should be shown when the issue is being edited.

Parameters
fieldLayoutItem FieldLayoutItem
operationContext OperationContext
action Action
issue Issue
displayParameters Map of display parameters.
Returns
  • HTML that should be shown when the issue is being edited.

public FieldTypeInfo getFieldTypeInfo (FieldTypeInfoContext fieldTypeInfoContext)

Returns lower level Information about the field. This information contains allowed values and/or the autocomplete url

Parameters
fieldTypeInfoContext the FieldTypeInfoContext contains context information that is relevant to generate the FieldTypeInfo

public JsonData getJsonDefaultValue (IssueContext issueCtx)

Return The default data for this system field. May be null if there is no default.

Parameters
issueCtx Issue (This should really only need to be an issue context, but for historical reasons we need an issue object.

public FieldJsonRepresentation getJsonFromIssue (Issue issue, boolean renderedVersionRequested, FieldLayoutItem fieldLayoutItem)

Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.

Parameters
issue to get field data from
renderedVersionRequested whether the use requested the return of rendered/pretty data as well as raw data
fieldLayoutItem field layout for this field. Will only be supplied if the field is also an ordereable field.
Returns
  • FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.

public JsonType getJsonSchema ()

Return a description of the shape of this field when represented as JSON.

public RestFieldOperationsHandler getRestFieldOperation ()

public String getValueFromIssue (Issue issue)

Gets the value stored for this field on the provided issue.

Parameters
issue identifies the issue that will contain the value for this field.
Returns
  • the value stored on this issue for this field, null if not applicable.

public Object getValueFromParams (Map params)

Get a field value from the map of parameters passed. The params map may contain other parameters that are not relevant to this custom field.

Parameters
params the map of parameters.
Returns
  • Value for this field from the map of parameters.
Throws
FieldValidationException

public String getViewHtml (FieldLayoutItem fieldLayoutItem, Action action, Issue issue, Map displayParameters)

public String getViewHtml (FieldLayoutItem fieldLayoutItem, Action action, Issue issue, Object value, Map displayParameters)

public boolean hasValue (Issue issue)

Determines if the field has a value for the given issue.

Parameters
issue the Issue.
Returns
  • true if the given Issue has a value for this field.

public boolean isRenderable ()

Defines if a field determines itself as renderable. This is needed because of the way that customfields are implemented. Since all the real work is done in CustomFieldTypes, if we want to treat system fields and custom fields the same way in the renderers then all custom fields must implement this interface. We therefore provide this method so that the CustomFieldImpl can delegate to the CustomFieldTypes to determine if a given custom field is renderable.

Returns
  • true if the field is renderable, false otherwise.

public boolean isShown (Issue issue)

Tests field specific way to determine if it should be shown or not.

Parameters
issue The Issue.
Returns
  • true if it should be shown.

public MessagedResult needsMove (Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem)

Used to determine if the field needs input from user to be moved to the new project and/or issue type. This method is called only if the field is visible in the target project/issue type.

Parameters
originalIssues Collection of original Issues.
targetIssue Target Issue.
targetFieldLayoutItem FieldLayoutItem
Returns
  • A MessagedResult with result=true if the field needs input to be moved.

public void populateDefaults (Map<String, Object> fieldValuesHolder, Issue issue)

Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet.

Parameters
fieldValuesHolder The fieldValuesHolder Map to be populated.
issue The Issue.

public void populateForMove (Map<String, Object> fieldValuesHolder, Issue originalIssue, Issue targetIssue)

Used to populate the fieldValueHolder with parameters for move issue screen. This field is only called if the issue needs to be updated during move, i.e. needsMove(java.util.Collection, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem) returned true, and the remote user (the one performing the move) has the permission to actually update this field.

Parameters
fieldValuesHolder Map of field Values.
originalIssue orignal Issue
targetIssue target Issue

public void populateFromIssue (Map<String, Object> fieldValuesHolder, Issue issue)

Used to initialise the fieldValuesHolder from the current value of teh issue. Used, for example, when showing the Edit Issue screen to show the issue's current values.

Parameters
fieldValuesHolder The fieldValuesHolder Map to be populated.
issue The Issue.

public void populateParamsFromString (Map<String, Object> fieldValuesHolder, String stringValue, Issue issue)

Used to convert from a user friendly string value and put the result into the fieldValuesHolder. This method is useful for places like Jelly where the field value can be a name (e.g. issue type name) and not a regular id that is used in the web pages.

Parameters
fieldValuesHolder Map of field Values.
stringValue user friendly string value
issue the Issue
Throws
FieldValidationException

public void removeValueFromIssueObject (MutableIssue issue)

Removes the field value from the given MutableIssue object.

Note that this operation does not actually persist the change, it just clears the value from the given Issue object. The caller will still need to call #updateValue() in order to persist the change.

Some Fields may choose to quietly ignore this request. eg The SecurityLevel Field will not remove Security Level from subtasks because the subtask must always take the Security Level of its parent issue.

Parameters
issue The issue object to be effected.

public void setLoggedInUser (ApplicationUser loggedInUser)

Explicitly set current session

public void updateIssue (FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder)

Sets the value as a modified external field in the issue so that this field will be updated along with all the other modified issue values.

Parameters
fieldLayoutItem FieldLayoutItem
issue MutableIssue
fieldValueHolder Field Value Holder Map

public void updateValue (FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder)

Update the issue in the data store.

Fields that are simply stored in the JIRAISSUE DB table, need not do anything here as this table is written to one time to include all fields that changed. Fields using other DB tables must update that table with the appropriate values.

Parameters
fieldLayoutItem for this field within this context
issue Issue this field is part of
modifiedValue new value to set field to. Cannot be null.
issueChangeHolder an object to record any changes made to the issue by this method.

public void validateParams (OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)

Ensure that the parameters are valid

Parameters
operationContext OperationContext
errorCollectionToAddTo ErrorCollection to add to.
i18n I18nHelper
issue This is passed to get the value of other fields that may or may not have been modified.
fieldScreenRenderLayoutItem FieldScreenRenderLayoutItem

Protected Methods

protected Object getRelevantParams (Map<String, String[]> inputParameters)

Defines the object that will be passed through to the create method

Parameters
inputParameters is a representation of the request params that are available
Returns