|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TrackingStatisticService
Service for accessing StatisticsFieldConfig
and StatisticsField
objects relating to the
Tracking Statistic(s) of a RapidView
.
Field Summary | |
---|---|
static java.lang.String |
REMAINING_ESTIMATE_FIELD_ID
The JIRA Field ID that represents TimeEstimateSystemField when used
in a StatisticsFieldConfig . |
Method Summary | |
---|---|
java.util.List<StatisticsField> |
getAvailableTrackingStatistics()
Returns the list of StatisticsField s which represent the available StatisticsFieldConfig s. |
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 |
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.) |
boolean |
isTrackingStatisticFieldAndNotApplicable(StatisticsField trackingStatistic,
java.lang.Long projectId,
java.lang.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.) |
boolean |
isTrackingStatisticValidAndEnabled(StatisticsField trackingStatistic)
Is the StatisticsField valid and enabled (i.e. |
ServiceOutcome<java.lang.Void> |
updateTrackingStatistic(com.atlassian.crowd.embedded.api.User user,
RapidView rapidView,
StatisticsFieldConfig trackingStatistic)
Updates the specified rapid view to a new configuration. |
Field Detail |
---|
static final java.lang.String REMAINING_ESTIMATE_FIELD_ID
TimeEstimateSystemField
when used
in a StatisticsFieldConfig
.
Method Detail |
---|
@NotNull java.util.List<StatisticsField> getAvailableTrackingStatistics()
StatisticsField
s which represent the available StatisticsFieldConfig
s.
@NotNull ServiceOutcome<java.lang.Void> updateTrackingStatistic(com.atlassian.crowd.embedded.api.User user, @NotNull RapidView rapidView, @NotNull StatisticsFieldConfig trackingStatistic)
user
- the userrapidView
- the rapid viewtrackingStatistic
- the new configuration
@NotNull ServiceOutcome<StatisticsField> getTrackingStatisticStrict(@NotNull RapidView rapidView)
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)
.
rapidView
- the rapid view
getInvalidTrackingStatistic(com.atlassian.greenhopper.model.rapid.RapidView)
,
getTrackingStatistic(com.atlassian.greenhopper.model.rapid.RapidView)
@NotNull StatisticsField getTrackingStatistic(@NotNull RapidView rapidView)
StatisticsField
, which may or may not be valid.
rapidView
- the rapid view
@NotNull StatisticsField getInvalidTrackingStatistic(@NotNull RapidView rapidView)
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.
rapidView
- the rapid view
boolean isTrackingStatisticFieldAndNotApplicable(StatisticsField trackingStatistic, com.atlassian.jira.issue.Issue issue)
StatisticsField
field based but not applicable for the given issue? (Due to Custom Field configuration
contexts, for example.)
trackingStatistic
- the tracking statisticissue
- the issue
isTrackingStatisticFieldAndNotApplicable(com.atlassian.greenhopper.model.rapid.StatisticsField, Long, String)
boolean isTrackingStatisticFieldAndNotApplicable(StatisticsField trackingStatistic, java.lang.Long projectId, java.lang.String issueTypeId)
StatisticsField
field based but not applicable for the given project and issue type?
(Due to Custom Field configuration contexts, for example.)
trackingStatistic
- the tracking statisticprojectId
- the ID of the projectissueTypeId
- the ID of the issue type
isTrackingStatisticFieldAndNotApplicable(StatisticsField, Issue)
boolean isTrackingStatisticValidAndEnabled(StatisticsField trackingStatistic)
StatisticsField
valid and enabled (i.e. should it take part in accumulating statistics over issues)?
trackingStatistic
- the tracking statistic
StatisticsField.isValid()
,
StatisticsField.isEnabled()
boolean isRemainingEstimateStatisticsField(StatisticsField statisticsField)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |