|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EstimateStatisticService
Service for accessing StatisticsFieldConfig
and StatisticsField
objects relating to the
Estimate Statistic(s) of a RapidView
.
Field Summary | |
---|---|
static java.lang.String |
ORIGINAL_ESTIMATE_FIELD_ID
The JIRA Field ID that represents OriginalEstimateSystemField when used
in a StatisticsFieldConfig . |
Method Summary | |
---|---|
java.util.List<StatisticsField> |
getAvailableEstimateStatistics()
Returns the list of StatisticsField s which represent the available StatisticsFieldConfig s. |
StatisticsField |
getEstimateStatistic(RapidView rapidView)
Will always return a StatisticsField , which may or may not be valid. |
ServiceOutcome<StatisticsField> |
getEstimateStatisticStrict(RapidView rapidView)
Attempts to get the StatisticsField of a rapid view. |
StatisticsField |
getInvalidEstimateStatistic(RapidView rapidView)
Returns a StatisticsField instance which represents an invalid StatisticsFieldConfig . |
boolean |
isEstimateStatisticFieldAndNotApplicable(StatisticsField estimateStatistic,
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 |
isEstimateStatisticFieldAndNotApplicable(StatisticsField estimateStatistic,
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 |
isEstimateStatisticValidAndEnabled(StatisticsField estimateStatistic)
Is the StatisticsField valid and enabled (i.e. |
ServiceOutcome<java.lang.Void> |
updateEstimateStatistic(com.atlassian.crowd.embedded.api.User user,
RapidView rapidView,
StatisticsFieldConfig estimateStatistic)
Updates the specified rapid view to a new configuration. |
Field Detail |
---|
static final java.lang.String ORIGINAL_ESTIMATE_FIELD_ID
OriginalEstimateSystemField
when used
in a StatisticsFieldConfig
.
Method Detail |
---|
@NotNull java.util.List<StatisticsField> getAvailableEstimateStatistics()
StatisticsField
s which represent the available StatisticsFieldConfig
s.
@NotNull ServiceOutcome<java.lang.Void> updateEstimateStatistic(com.atlassian.crowd.embedded.api.User user, @NotNull RapidView rapidView, @NotNull StatisticsFieldConfig estimateStatistic)
user
- the userrapidView
- the rapid viewestimateStatistic
- the new configuration
@NotNull ServiceOutcome<StatisticsField> getEstimateStatisticStrict(@NotNull RapidView rapidView)
StatisticsField
of a rapid view. Outcome will contain errors if the configured
estimate statistic is invalid. You may wish to call getInvalidEstimateStatistic(com.atlassian.greenhopper.model.rapid.RapidView)
in that case.
If you just want either the valid or invalid StatisticsField
to be returned, call getEstimateStatistic(com.atlassian.greenhopper.model.rapid.RapidView)
.
rapidView
- the rapid view
getInvalidEstimateStatistic(com.atlassian.greenhopper.model.rapid.RapidView)
,
getEstimateStatistic(com.atlassian.greenhopper.model.rapid.RapidView)
@NotNull StatisticsField getEstimateStatistic(@NotNull RapidView rapidView)
StatisticsField
, which may or may not be valid.
rapidView
- the rapid view
@NotNull StatisticsField getInvalidEstimateStatistic(@NotNull RapidView rapidView)
StatisticsField
instance which represents an invalid StatisticsFieldConfig
. This only
really makes sense to call if you have previously called getEstimateStatisticStrict(com.atlassian.greenhopper.model.rapid.RapidView)
and were returned errors.
rapidView
- the rapid view
boolean isEstimateStatisticFieldAndNotApplicable(StatisticsField estimateStatistic, com.atlassian.jira.issue.Issue issue)
StatisticsField
field based but not applicable for the given issue? (Due to Custom Field configuration
contexts, for example.)
estimateStatistic
- the estimate statisticissue
- the issue
isEstimateStatisticFieldAndNotApplicable(com.atlassian.greenhopper.model.rapid.StatisticsField, Long, String)
boolean isEstimateStatisticFieldAndNotApplicable(StatisticsField estimateStatistic, 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.)
estimateStatistic
- the estimate statisticprojectId
- the ID of the projectissueTypeId
- the ID of the issue type
isEstimateStatisticFieldAndNotApplicable(StatisticsField, Issue)
boolean isEstimateStatisticValidAndEnabled(StatisticsField estimateStatistic)
StatisticsField
valid and enabled (i.e. should it take part in accumulating statistics over issues)?
estimateStatistic
- the estimate statistic
StatisticsField.isValid()
,
StatisticsField.isEnabled()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |