public class TimeTrackingSystemField extends AbstractOrderableField<Object> implements HideableField, RequirableField, RestAwareField, RestFieldOperations
Since 4.2 it has two modes of operation, the older legacy mode that keeps original and remaining estimate tied together while work is not logged and the more modern mode that allows the 2 values to be edited and set independently.
NOTES: Whenever you see the targetSubField mentioned its because the UpdateIssueFieldFunction
tries to jam 1 value into this field. in the past this kinda worked but in the post separation world, it becomes more complicated.
So we keep track of the "target" that wants to be updated and then we spend lots of effort making sure only that sub field gets updated.
Modifier and Type | Class and Description |
---|---|
static interface |
TimeTrackingSystemField.TimeTrackingValue
This interface is used as a value object for TimeTracking information.
|
Modifier and Type | Field and Description |
---|---|
static String |
TIMETRACKING_ORIGINALESTIMATE |
static String |
TIMETRACKING_REMAININGESTIMATE |
static String |
TIMETRACKING_TARGETSUBFIELD
When this input parameter is specified then we are only wanted to set a specific sub field of time tracking.
|
authenticationContext
MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY, TEMPLATE_DIRECTORY_PATH
Constructor and Description |
---|
TimeTrackingSystemField(VelocityTemplatingEngine templatingEngine,
ApplicationProperties applicationProperties,
IssueManager issueManager,
JiraAuthenticationContext authenticationContext,
PermissionManager permissionManager,
JiraDurationUtils jiraDurationUtils) |
Modifier and Type | Method and Description |
---|---|
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 OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value. |
void |
createValue(Issue issue,
Object value)
Create the value of the issue in the data store.
|
String |
getBulkEditHtml(OperationContext operationContext,
webwork.action.Action action,
BulkEditBean bulkEditBean,
Map displayParameters)
Returns HTML that should be shown when the issue is being bulk edited.
|
String |
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.
|
TimeTrackingSystemField.TimeTrackingValue |
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,
webwork.action.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.
|
protected Object |
getRelevantParams(Map<String,String[]> inputParameters)
This is implemented in response to use being an AbstractOrderableField.
|
RestFieldOperationsHandler |
getRestFieldOperation() |
TimeTrackingSystemField.TimeTrackingValue |
getValueFromParams(Map fieldValueHolder)
This is called from BulkEdit/BulkWorkflowTransition to get an value object from a input set of values.
|
String |
getViewHtml(FieldLayoutItem fieldLayoutItem,
webwork.action.Action action,
Issue issue,
Map displayParameters) |
String |
getViewHtml(FieldLayoutItem fieldLayoutItem,
webwork.action.Action action,
Issue issue,
Object value,
Map displayParameters) |
boolean |
hasParam(Map parameters)
Basic implementation where the relevant params object is null if no elements are present.
|
boolean |
hasValue(Issue issue)
Determines if the field has a value for the given issue.
|
boolean |
hasWorkStarted(Issue issue) |
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)
We don't return any default for the TimeTracking field.
|
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)
This is called to populate the field values holder with the current state of the Issue object.
|
void |
populateFromParams(Map<String,Object> fieldValuesHolder,
Map<String,String[]> inputParameters)
This will populate the field values holder map with the time tracking value contained within the map of
(typically but not always web) parameters.
|
void |
populateParamsFromString(Map<String,Object> fieldValuesHolder,
String stringValue,
Issue issue)
This is called by Jelly code to map a value into a field values holder.
|
void |
removeValueFromIssueObject(MutableIssue issue)
Removes the field value from the given MutableIssue object.
|
void |
updateIssue(FieldLayoutItem fieldLayoutItem,
MutableIssue issue,
Map fieldValueHolder)
This is called to back update the MutableIssue with the value object we previously stuffed into the field values
holder.
|
void |
updateValue(FieldLayoutItem fieldLayoutItem,
Issue issue,
ModifiedValue modifiedValue,
IssueChangeHolder issueChangeHolder)
This is called after the issue has been stored on disk and allows us a chance to create change records for the
update.
|
void |
validateParams(OperationContext operationContext,
ErrorCollection errorCollection,
I18nHelper i18n,
Issue issue,
FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
Ensure that the parameters are valid
|
createAssociatedSearchHandler, getApplicationProperties, getCreateHtml, getEditHtml, getPermissionManager, getVelocityParams, getVelocityParams, getViewHtml, hasBulkUpdatePermission, hasPermission, isHidden, rendererTypesEqual, renderTemplate, valuesEqual
compareTo, equals, getAuthenticationContext, getId, getName, getNameKey, hashCode
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
getId, getName, getNameKey
compareTo
public static final String TIMETRACKING_TARGETSUBFIELD
This is used by the UpdateIssueFieldFunction
so that it can
set say original estimate only for example.
public static final String TIMETRACKING_ORIGINALESTIMATE
public static final String TIMETRACKING_REMAININGESTIMATE
public TimeTrackingSystemField(VelocityTemplatingEngine templatingEngine, ApplicationProperties applicationProperties, IssueManager issueManager, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, JiraDurationUtils jiraDurationUtils)
public String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters)
OrderableField
getCreateHtml
in interface OrderableField<Object>
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.public String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map displayParameters)
OrderableField
getEditHtml
in interface OrderableField<Object>
fieldLayoutItem
- FieldLayoutItemoperationContext
- OperationContextaction
- Actionissue
- IssuedisplayParameters
- Map of display parameters.public String getBulkEditHtml(OperationContext operationContext, webwork.action.Action action, BulkEditBean bulkEditBean, Map displayParameters)
AbstractOrderableField
OrderableField.getEditHtml(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, com.atlassian.jira.issue.customfields.OperationContext, webwork.action.Action, com.atlassian.jira.issue.Issue, java.util.Map)
method with null for FieldLayoutItem
and the first issue in the collection}getBulkEditHtml
in interface OrderableField<Object>
getBulkEditHtml
in class AbstractOrderableField<Object>
operationContext
- OperationContextaction
- ActionbulkEditBean
- BulkEditBeandisplayParameters
- Map of display parameters.public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters)
getViewHtml
in interface OrderableField<Object>
public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Object value, Map displayParameters)
getViewHtml
in interface OrderableField<Object>
public void createValue(Issue issue, Object value)
OrderableField
createValue
in interface OrderableField<Object>
issue
- Issue this field is part ofvalue
- Value to store in this field (eg. Collection for Version fields). Cannot be null.public TimeTrackingSystemField.TimeTrackingValue getDefaultValue(Issue issue)
OrderableField
For example: The user does not have permission to see the field, or the field is not part of the create screen.
getDefaultValue
in interface OrderableField<Object>
issue
- the Issue.public void populateDefaults(Map<String,Object> fieldValuesHolder, Issue issue)
populateDefaults
in interface OrderableField<Object>
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The issue in play.public void populateParamsFromString(Map<String,Object> fieldValuesHolder, String stringValue, Issue issue) throws FieldValidationException
populateParamsFromString
in interface OrderableField<Object>
fieldValuesHolder
- Map of field Values.stringValue
- user friendly string value.issue
- the issue in play.FieldValidationException
public void populateForMove(Map<String,Object> fieldValuesHolder, Issue originalIssue, Issue targetIssue)
OrderableField
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.populateForMove
in interface OrderableField<Object>
fieldValuesHolder
- Map of field Values.originalIssue
- orignal IssuetargetIssue
- target Issuepublic boolean hasParam(Map parameters)
AbstractOrderableField
hasParam
in interface OrderableField<Object>
hasParam
in class AbstractOrderableField<Object>
parameters
- Map of parameters.public void populateFromParams(Map<String,Object> fieldValuesHolder, Map<String,String[]> inputParameters)
We override this so we can see this happen. This helps for debugging reasons. Damn you class hierarchies, you are confusing me!
This will end up calling getRelevantParams(java.util.Map<java.lang.String, java.lang.String[]>)
by the way.
populateFromParams
in interface OrderableField<Object>
populateFromParams
in class AbstractOrderableField<Object>
fieldValuesHolder
- the writable map of field values in play.inputParameters
- the input parameters.protected Object getRelevantParams(Map<String,String[]> inputParameters)
getRelevantParams
in class AbstractOrderableField<Object>
inputParameters
- the input parameters.public void populateFromIssue(Map<String,Object> fieldValuesHolder, Issue issue)
populateFromIssue
in interface OrderableField<Object>
fieldValuesHolder
- The fieldValuesHolder Map to be populated.issue
- The issue in play.public void validateParams(OperationContext operationContext, ErrorCollection errorCollection, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
OrderableField
validateParams
in interface OrderableField<Object>
operationContext
- OperationContexterrorCollection
- 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
- FieldScreenRenderLayoutItempublic TimeTrackingSystemField.TimeTrackingValue getValueFromParams(Map fieldValueHolder)
getValueFromParams
in interface OrderableField<Object>
fieldValueHolder
- the map of parameters.public void updateIssue(FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder)
This is called to back update the MutableIssue with the value object we previously stuffed into the field values holder.
This is called prior to the issue being stored on disk.
updateIssue
in interface OrderableField<Object>
fieldLayoutItem
- FieldLayoutItem in play.issue
- MutableIssue in play.fieldValueHolder
- Field Value Holder Map.OrderableField.updateValue(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.ModifiedValue, com.atlassian.jira.issue.util.IssueChangeHolder)
public void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder)
updateValue
in interface OrderableField<Object>
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 MessagedResult needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem)
OrderableField
needsMove
in interface OrderableField<Object>
originalIssues
- Collection of original Issues.targetIssue
- Nonexistent issue object with values representing those of issue(s) after movetargetFieldLayoutItem
- FieldLayoutItempublic void removeValueFromIssueObject(MutableIssue issue)
OrderableField
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.
removeValueFromIssueObject
in interface OrderableField<Object>
issue
- The issue object to be effected.OrderableField.canRemoveValueFromIssueObject(com.atlassian.jira.issue.Issue)
,
OrderableField.updateValue(com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem, com.atlassian.jira.issue.Issue, com.atlassian.jira.issue.ModifiedValue, com.atlassian.jira.issue.util.IssueChangeHolder)
public boolean isShown(Issue issue)
OrderableField
isShown
in interface OrderableField<Object>
issue
- The Issue.public boolean canRemoveValueFromIssueObject(Issue issue)
OrderableField
true
if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.
There a few different reasons why this method may return false:
canRemoveValueFromIssueObject
in interface OrderableField<Object>
issue
- The Issue object.true
if a call to OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
will actually remove the value.OrderableField.removeValueFromIssueObject(com.atlassian.jira.issue.MutableIssue)
public boolean hasValue(Issue issue)
OrderableField
hasValue
in interface OrderableField<Object>
issue
- the Issue.public String availableForBulkEdit(BulkEditBean bulkEditBean)
OrderableField
availableForBulkEdit
in interface OrderableField<Object>
bulkEditBean
- holds the state of the bulk-edit wizard (e.g. the selected issues for bulk editing)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 hasWorkStarted(Issue issue)
public FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)
RestAwareField
getFieldTypeInfo
in interface RestAwareField
fieldTypeInfoContext
- the FieldTypeInfoContext
contains context information that is relevant to generate the FieldTypeInfo
public JsonType getJsonSchema()
RestAwareField
getJsonSchema
in interface RestAwareField
public FieldJsonRepresentation getJsonFromIssue(Issue issue, boolean renderedVersionRequested, @Nullable FieldLayoutItem fieldLayoutItem)
RestAwareField
getJsonFromIssue
in interface RestAwareField
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.public RestFieldOperationsHandler getRestFieldOperation()
getRestFieldOperation
in interface RestFieldOperations
public JsonData getJsonDefaultValue(IssueContext issueCtx)
RestFieldOperations
getJsonDefaultValue
in interface RestFieldOperations
issueCtx
- Issue (This should really only need to be an issue context, but for historical reasons we need an issue object.Copyright © 2002-2017 Atlassian. All Rights Reserved.