Class WorklogSystemField
- All Implemented Interfaces:
ExportableSystemField
,Field
,HideableField
,OrderableField<WorklogSystemField.WorklogValue>
,RenderableField
,RequirableField
,RestAwareField
,RestFieldOperations
,SearchableField
,Comparable
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.
- Since:
- v4.2
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
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. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
Fields inherited from class com.atlassian.jira.issue.fields.AbstractField
authenticationContext
Fields inherited from interface com.atlassian.jira.issue.fields.OrderableField
MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATH
-
Constructor Summary
ConstructorsConstructorDescriptionWorklogSystemField
(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, ComponentLocator componentLocator, GroupManager groupManager, DateTimeFormatterFactory dateTimeFormatterFactory, JiraBaseUrls jiraBaseUrls, EmailFormatter emailFormatter, CsvDateFormatter csvDateFormatter) -
Method Summary
Modifier and TypeMethodDescriptionavailableForBulkEdit
(BulkEditBean bulkEditBean) Determines whether the field is available for bulk editing given the BulkEditBean.boolean
Returnstrue
if a call toOrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.void
createValue
(Issue issue, WorklogSystemField.WorklogValue value) Create the value of the issue in the data store.getCreateHtml
(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Returns the HTML that should be shown when the issue is being created.getDefaultValue
(Issue issue) The value that should be set on the issue if the field is not shown for some reason.getEditHtml
(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Returns HTML that should be shown when the issue is being edited.getFieldTypeInfo
(FieldTypeInfoContext fieldTypeInfoContext) Returns lower level Information about the field.getJsonDefaultValue
(IssueContext issueCtx) Return The default data for this system field.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.Return a description of the shape of this field when represented as JSON.protected Object
getRelevantParams
(Map<String, String[]> inputParameters) Defines the object that will be passed through to the create methodgetRepresentationFromIssue
(Issue issue) This generates a multi-valued worklog entries in the format: [comment;][createdTime;author;]secondsLogged e.g.getValueFromIssue
(Issue issue) Gets the value stored for this field on the provided issue.getValueFromParams
(Map params) Get a field value from the map of parameters passed.getViewHtml
(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, WorklogSystemField.WorklogValue value, Map displayParameters) getViewHtml
(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters) boolean
Determines if the field has a value for the given issue.boolean
Defines if a field determines itself as renderable.boolean
Tests field specific way to determine if it should be shown or not.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
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
Used to convert from a user friendly string value and put the result into the fieldValuesHolder.void
Removes the field value from the given MutableIssue object.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 validMethods inherited from class com.atlassian.jira.issue.fields.AbstractOrderableField
createAssociatedSearchHandler, getApplicationProperties, getBulkEditHtml, getCreateHtml, getEditHtml, getFieldLayoutItemForBulkOperation, getIssueForBulkOperation, getPermissionManager, getVelocityParams, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasParam, hasPermission, isHidden, populateFromParams, rendererTypesEqual, renderTemplate, validateBulkEditHtmlProperties, valuesEqual
Methods inherited from class com.atlassian.jira.issue.fields.AbstractField
compareTo, equals, getAuthenticationContext, getId, getName, getNameKey, hashCode
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.atlassian.jira.issue.fields.Field
getId, getName, getNameKey
Methods inherited from interface com.atlassian.jira.issue.fields.renderer.RenderableField
getId
-
Field Details
-
WORKLOG_TIMELOGGED
- See Also:
-
WORKLOG_STARTDATE
- See Also:
-
WORKLOG_NEWESTIMATE
- See Also:
-
WORKLOG_ADJUSTMENTAMOUNT
- See Also:
-
WORKLOG_ADJUSTESTIMATE
- See Also:
-
WORKLOG_ACTIVATE
- See Also:
-
WORKLOG_ID
- See Also:
-
WORKLOG_DESCRIPTION
- See Also:
-
WORKLOG_VISIBILITY_LEVEL
- See Also:
-
PARAM_ISCREATEISSUE
- See Also:
-
PARAM_ISEDITLOG
- See Also:
-
PARAM_ISDELETELOG
- See Also:
-
-
Constructor Details
-
WorklogSystemField
public WorklogSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, ComponentLocator componentLocator, GroupManager groupManager, DateTimeFormatterFactory dateTimeFormatterFactory, JiraBaseUrls jiraBaseUrls, EmailFormatter emailFormatter, CsvDateFormatter csvDateFormatter)
-
-
Method Details
-
getRelevantParams
Defines the object that will be passed through to the create method- Specified by:
getRelevantParams
in classAbstractOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
inputParameters
- is a representation of the request params that are available- Returns:
- an object that holds the params we need for this Field.
WorklogSystemField.WorklogValue
-
validateParams
public void validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem) Description copied from interface:OrderableField
Ensure that the parameters are valid- Specified by:
validateParams
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
operationContext
- OperationContexterrorCollectionToAddTo
- ErrorCollection to add to.i18n
- I18nHelperissue
- This is passed to get the value of other fields that may or may not have been modified.fieldScreenRenderLayoutItem
- FieldScreenRenderLayoutItem
-
getCreateHtml
public String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Description copied from interface:OrderableField
Returns the HTML that should be shown when the issue is being created.- Specified by:
getCreateHtml
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.- Returns:
- the HTML that should be shown when the issue is being created.
-
getEditHtml
public String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters) Description copied from interface:OrderableField
Returns HTML that should be shown when the issue is being edited.- Specified by:
getEditHtml
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.- Returns:
- HTML that should be shown when the issue is being edited.
-
getViewHtml
public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters) - Specified by:
getViewHtml
in interfaceOrderableField<WorklogSystemField.WorklogValue>
-
getViewHtml
public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, WorklogSystemField.WorklogValue value, Map displayParameters) - Specified by:
getViewHtml
in interfaceOrderableField<WorklogSystemField.WorklogValue>
-
isShown
Description copied from interface:OrderableField
Tests field specific way to determine if it should be shown or not.- Specified by:
isShown
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
issue
- The Issue.- Returns:
- true if it should be shown.
-
populateDefaults
Description copied from interface:OrderableField
Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet.- Specified by:
populateDefaults
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The Issue.
-
populateFromIssue
Description copied from interface:OrderableField
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.- Specified by:
populateFromIssue
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The Issue.
-
getDefaultValue
Description copied from interface:OrderableField
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.
- Specified by:
getDefaultValue
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
issue
- the Issue.- Returns:
- The default value. It can be null, or an empty collection.
-
createValue
Description copied from interface:OrderableField
Create the value of the issue in the data store.- Specified by:
createValue
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
issue
- Issue this field is part ofvalue
- Value to store in this field (eg. Collection for Version fields). Cannot be null.
-
updateValue
public void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder) Description copied from interface:OrderableField
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.
- Specified by:
updateValue
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
fieldLayoutItem
- for this field within this contextissue
- Issue this field is part ofmodifiedValue
- new value to set field to. Cannot be null.issueChangeHolder
- an object to record any changes made to the issue by this method.
-
updateIssue
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.- Specified by:
updateIssue
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
fieldLayoutItem
- FieldLayoutItemissue
- MutableIssuefieldValueHolder
- Field Value Holder Map- See Also:
-
needsMove
public MessagedResult needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem) Description copied from interface:OrderableField
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.- Specified by:
needsMove
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
originalIssues
- Collection of original Issues.targetIssue
- Nonexistent issue object with values representing those of issue(s) after movetargetFieldLayoutItem
- FieldLayoutItem- Returns:
- A MessagedResult with result=true if the field needs input to be moved.
-
populateForMove
public void populateForMove(Map<String, Object> fieldValuesHolder, Issue originalIssue, Issue targetIssue) Description copied from interface:OrderableField
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.OrderableField.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.- Specified by:
populateForMove
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
fieldValuesHolder
- Map of field Values.originalIssue
- orignal IssuetargetIssue
- target Issue
-
removeValueFromIssueObject
Description copied from interface:OrderableField
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.
- Specified by:
removeValueFromIssueObject
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
issue
- The issue object to be effected.- See Also:
-
canRemoveValueFromIssueObject
Description copied from interface:OrderableField
Returnstrue
if a call toOrderableField.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.
- Specified by:
canRemoveValueFromIssueObject
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
issue
- The Issue object.- Returns:
true
if a call toOrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.- See Also:
-
hasValue
Description copied from interface:OrderableField
Determines if the field has a value for the given issue.- Specified by:
hasValue
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
issue
- the Issue.- Returns:
- true if the given Issue has a value for this field.
-
getValueFromParams
public WorklogSystemField.WorklogValue getValueFromParams(Map params) throws FieldValidationException Description copied from interface:OrderableField
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.- Specified by:
getValueFromParams
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
params
- the map of parameters.- Returns:
- Value for this field from the map of parameters.
- Throws:
FieldValidationException
- if there is a problem with Field Validation.
-
populateParamsFromString
public void populateParamsFromString(Map<String, Object> fieldValuesHolder, String stringValue, Issue issue) throws FieldValidationExceptionDescription copied from interface:OrderableField
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.- Specified by:
populateParamsFromString
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- Parameters:
fieldValuesHolder
- Map of field Values.stringValue
- user friendly string valueissue
- the Issue- Throws:
FieldValidationException
- if cannot convert to a value from the given string
-
availableForBulkEdit
Description copied from interface:OrderableField
Determines whether the field is available for bulk editing given the BulkEditBean.- Specified by:
availableForBulkEdit
in interfaceOrderableField<WorklogSystemField.WorklogValue>
- 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.
-
getValueFromIssue
Description copied from interface:RenderableField
Gets the value stored for this field on the provided issue.- Specified by:
getValueFromIssue
in interfaceRenderableField
- 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.
-
isRenderable
public boolean isRenderable()Description copied from interface:RenderableField
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.- Specified by:
isRenderable
in interfaceRenderableField
- Returns:
- true if the field is renderable, false otherwise.
-
getRestFieldOperation
- Specified by:
getRestFieldOperation
in interfaceRestFieldOperations
- Returns:
- the RestFieldOperationsHandler for this field.
-
getJsonDefaultValue
Description copied from interface:RestFieldOperations
Return The default data for this system field. May be null if there is no default.- Specified by:
getJsonDefaultValue
in interfaceRestFieldOperations
- Parameters:
issueCtx
- Issue (This should really only need to be an issue context, but for historical reasons we need an issue object.
-
getFieldTypeInfo
Description copied from interface:RestAwareField
Returns lower level Information about the field. This information contains allowed values and/or the autocomplete url- Specified by:
getFieldTypeInfo
in interfaceRestAwareField
- Parameters:
fieldTypeInfoContext
- theFieldTypeInfoContext
contains context information that is relevant to generate theFieldTypeInfo
-
getJsonSchema
Description copied from interface:RestAwareField
Return a description of the shape of this field when represented as JSON.- Specified by:
getJsonSchema
in interfaceRestAwareField
-
getJsonFromIssue
public FieldJsonRepresentation getJsonFromIssue(Issue issue, boolean renderedVersionRequested, @Nullable FieldLayoutItem fieldLayoutItem) Description copied from interface:RestAwareField
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.- Specified by:
getJsonFromIssue
in interfaceRestAwareField
- Parameters:
issue
- to get field data fromrenderedVersionRequested
- whether the use requested the return of rendered/pretty data as well as raw datafieldLayoutItem
- 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.
-
getRepresentationFromIssue
This generates a multi-valued worklog entries in the format: [comment;][createdTime;author;]secondsLogged e.g. {pre} Testing took me 3 days;2012-02-10 12:30:10;wseliga;259200 {/pre} Note the minimum necessary data for the column is the seconds logged but you can also include the time for the log and any comment for it.- Specified by:
getRepresentationFromIssue
in interfaceExportableSystemField
- Parameters:
issue
- to get export representation for- Returns:
- multicolumn FieldCsvRepresentation of the work log
-