com.atlassian.jira.issue.fields

Interface TimeTrackingSystemField.TimeTrackingValue

Enclosing class:

TimeTrackingSystemField

public static interface TimeTrackingSystemField.TimeTrackingValue

This interface is used as a value object for TimeTracking information.

It lurks around inside the field values holder maps while JIRA does its thang. It's referenced by the velocity views and also by the TimeTrackingSystemField itself.

While the class is PUBLIC, it is only so that the Velocity template can get to it. Please do not consider this part of the JIRA API. It's for the TimeTrackingSystemField only. You have been warned :)

It exists so that we can cater for the 2 modes that this field can work in since 4.2.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TimeTrackingSystemField.TimeTrackingValue.Builder

Method Summary

Modifier and Type	Method and Description
Long	getEstimate()
String	getEstimateDisplayValue()
Long	getOriginalEstimate()
String	getOriginalEstimateDisplayValue()
Long	getRemainingEstimate()
String	getRemainingEstimateDisplayValue()
String	getTargetSubField() This exists to allow one bit of JIRA code UpdateIssueFieldFunction which is a workflow post function to set 1 specific sub field value.
boolean	isCreateIssue()
boolean	isInLegacyMode() This allows the input to drive what mode we work in.
boolean	isLogWorkActivated() Signifies if we will be ignoring the Remaining Estimate from the input parameters as a result of the Log Work form being activated.

Method Detail

isInLegacyMode

boolean isInLegacyMode()

This allows the input to drive what mode we work in. This is their to allows old SOAP clients to work, in that they may only provide 1 value even if the system as the new mode turned on.

Returns:

true if the values in the time tracking value object need to be treated in the mode legacy mode

isCreateIssue

boolean isCreateIssue()

isLogWorkActivated

boolean isLogWorkActivated()

Signifies if we will be ignoring the Remaining Estimate from the input parameters as a result of the Log Work form being activated. The checkbox is only ever rendered when both TimeTracking and Worklog system fields are rendered on the same screen.

Returns:

true if the "Log Work" checkbox from the WorklogSystemField was checked.

getTargetSubField

String getTargetSubField()

This exists to allow one bit of JIRA code UpdateIssueFieldFunction which is a workflow post function to set 1 specific sub field value. This allows us to work in modern mode but still only set one value.

Returns:

either null or TIMETRACKING_ORIGINALESTIMATE or TIMETRACKING_REMAININGESTIMATE

getOriginalEstimate

Long getOriginalEstimate()

getRemainingEstimate

Long getRemainingEstimate()

getEstimate

Long getEstimate()

getEstimateDisplayValue

String getEstimateDisplayValue()

getOriginalEstimateDisplayValue

String getOriginalEstimateDisplayValue()

getRemainingEstimateDisplayValue

String getRemainingEstimateDisplayValue()