com.atlassian.greenhopper.service.rapid.view.statistics

Interface TrackingStatisticService

All Known Implementing Classes:

TrackingStatisticServiceImpl

public interface TrackingStatisticService

Service for accessing StatisticsFieldConfig and StatisticsField objects relating to the Tracking Statistic(s) of a RapidView.

Since:

v5.9.8

Field Summary

Fields

Modifier and Type	Field and Description
static String	REMAINING_ESTIMATE_FIELD_ID The JIRA Field ID that represents TimeEstimateSystemField when used in a StatisticsFieldConfig.

Method Summary

Modifier and Type	Method and Description
List<StatisticsField>	getAvailableTrackingStatistics() Returns the list of StatisticsFields which represent the available StatisticsFieldConfigs.
ServiceOutcome<StatisticsField>	getInstanceOf(StatisticsFieldConfig config) Retrieve the StatisticsField configured in the StatisticFieldConfig
StatisticsField	getInvalidTrackingStatistic(RapidView rapidView) Returns a StatisticsField instance which represents an invalid StatisticsFieldConfig.
StatisticsField	getTrackingStatistic(RapidView rapidView) Will always return a StatisticsField, which may or may not be valid.
ServiceOutcome<StatisticsField>	getTrackingStatisticStrict(RapidView rapidView) Attempts to get the StatisticsField of a rapid view.
boolean	isRemainingEstimateStatisticsField(StatisticsField statisticsField) Is the passed StatisticsField of type remaining estimate?
boolean	isTrackingStatisticFieldAndApplicable(StatisticsField trackingStatistic, com.atlassian.jira.issue.Issue issue) Is the StatisticsField field based and applicable for the given issue?
boolean	isTrackingStatisticFieldAndNotApplicable(StatisticsField trackingStatistic, com.atlassian.jira.issue.Issue issue) Is the StatisticsField field based but not applicable for the given issue?
boolean	isTrackingStatisticFieldAndNotApplicable(StatisticsField trackingStatistic, Long projectId, String issueTypeId) Is the StatisticsField field based but not applicable for the given project and issue type?
boolean	isTrackingStatisticValidAndEnabled(StatisticsField trackingStatistic) Is the StatisticsField valid and enabled (i.e. should it take part in accumulating statistics over issues)?
ServiceResult	updateTrackingStatistic(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, StatisticsFieldConfig trackingStatistic) Updates the specified rapid view to a new configuration.

Field Detail

REMAINING_ESTIMATE_FIELD_ID

static final String REMAINING_ESTIMATE_FIELD_ID

The JIRA Field ID that represents TimeEstimateSystemField when used in a StatisticsFieldConfig.

See Also:

Constant Field Values

Method Detail

getAvailableTrackingStatistics

@Nonnull
List<StatisticsField> getAvailableTrackingStatistics()

Returns the list of StatisticsFields which represent the available StatisticsFieldConfigs.

Returns:

the list.

updateTrackingStatistic

@Nonnull
ServiceResult updateTrackingStatistic(com.atlassian.jira.user.ApplicationUser user,
                                               @Nonnull
                                               RapidView rapidView,
                                               @Nonnull
                                               StatisticsFieldConfig trackingStatistic)

Updates the specified rapid view to a new configuration.

Parameters:

user - the user

rapidView - the rapid view

trackingStatistic - the new configuration

Returns:

the outcome; possibly with errors

getTrackingStatisticStrict

@Nonnull
ServiceOutcome<StatisticsField> getTrackingStatisticStrict(@Nonnull
                                                                    RapidView rapidView)

Attempts to get the StatisticsField of a rapid view. Outcome will contain errors if the configured tracking statistic is invalid. You may wish to call getInvalidTrackingStatistic(com.atlassian.greenhopper.model.rapid.RapidView) in that case.

If you just want either the valid or invalid StatisticsField to be returned, call getTrackingStatistic(com.atlassian.greenhopper.model.rapid.RapidView).

Parameters:

rapidView - the rapid view

Returns:

strict outcome of valid statistics field; or errors

See Also:

getInvalidTrackingStatistic(com.atlassian.greenhopper.model.rapid.RapidView), getTrackingStatistic(com.atlassian.greenhopper.model.rapid.RapidView)

getTrackingStatistic

@Nonnull
StatisticsField getTrackingStatistic(@Nonnull
                                              RapidView rapidView)

Will always return a StatisticsField, which may or may not be valid.

Parameters:

rapidView - the rapid view

Returns:

the statistic field

getInvalidTrackingStatistic

@Nonnull
StatisticsField getInvalidTrackingStatistic(@Nonnull
                                                     RapidView rapidView)

Returns a StatisticsField instance which represents an invalid StatisticsFieldConfig. This only really makes sense to call if you have previously called getTrackingStatisticStrict(com.atlassian.greenhopper.model.rapid.RapidView) and were returned errors.

Parameters:

rapidView - the rapid view

Returns:

the invalid instance representing the configuration

getInstanceOf

@Nonnull
ServiceOutcome<StatisticsField> getInstanceOf(@Nonnull
                                                       StatisticsFieldConfig config)

Retrieve the StatisticsField configured in the StatisticFieldConfig

Parameters:

config - for the field

Returns:

StatisticField if can be found.

isTrackingStatisticFieldAndApplicable

boolean isTrackingStatisticFieldAndApplicable(StatisticsField trackingStatistic,
                                              com.atlassian.jira.issue.Issue issue)

Is the StatisticsField field based and applicable for the given issue? (Due to Custom Field configuration contexts, for example.)

Parameters:

trackingStatistic - the tracking statistic

issue - the issue

Returns:

the result

isTrackingStatisticFieldAndNotApplicable

boolean isTrackingStatisticFieldAndNotApplicable(StatisticsField trackingStatistic,
                                                 com.atlassian.jira.issue.Issue issue)

Is the StatisticsField field based but not applicable for the given issue? (Due to Custom Field configuration contexts, for example.)

Parameters:

trackingStatistic - the tracking statistic

issue - the issue

Returns:

the result

See Also:

isTrackingStatisticFieldAndNotApplicable(com.atlassian.greenhopper.model.rapid.StatisticsField, Long, String)

isTrackingStatisticFieldAndNotApplicable

boolean isTrackingStatisticFieldAndNotApplicable(StatisticsField trackingStatistic,
                                                 Long projectId,
                                                 String issueTypeId)

Is the StatisticsField field based but not applicable for the given project and issue type? (Due to Custom Field configuration contexts, for example.)

Parameters:

trackingStatistic - the tracking statistic

projectId - the ID of the project

issueTypeId - the ID of the issue type

Returns:

the result

See Also:

isTrackingStatisticFieldAndNotApplicable(StatisticsField, Issue)

isTrackingStatisticValidAndEnabled

boolean isTrackingStatisticValidAndEnabled(StatisticsField trackingStatistic)

Is the StatisticsField valid and enabled (i.e. should it take part in accumulating statistics over issues)?

Parameters:

trackingStatistic - the tracking statistic

Returns:

the result

See Also:

StatisticsField.isValid(), StatisticsField.isEnabled()

isRemainingEstimateStatisticsField

boolean isRemainingEstimateStatisticsField(StatisticsField statisticsField)

Is the passed StatisticsField of type remaining estimate?