com.atlassian.greenhopper.service.rapid.view
Interface StatisticsFieldService

All Superinterfaces:
GreenHopperCache
All Known Implementing Classes:
StatisticsFieldServiceImpl

public interface StatisticsFieldService
extends GreenHopperCache

Provides access to StatisticsFieldConfig and StatisticsFieldInstance.

Author:
mtokar

Method Summary
 java.util.List<StatisticsFieldConfig> getAvailableStatisticsFieldConfigs()
          Returns the list of StatisticsFieldConfigs which are available to be used in a RapidView.
 java.util.List<StatisticsFieldInstance> getAvailableStatisticsFields()
          Returns the list of StatisticsFieldInstances which represent the available StatisticsFieldConfigs.
 StatisticsFieldConfig getDefaultStatisticsFieldConfig()
          Returns the default StatisticsFieldConfig to use.
 ServiceOutcome<StatisticsFieldInstance> getInstanceOfField(StatisticsFieldConfig config)
          Returns the StatisticsFieldInstance representing the specified StatisticsFieldConfig.
 void invalidate(RapidView rapidView)
           
 ServiceOutcome<StatisticsFieldConfig> loadStatisticsField(RapidView rapidView)
           
 ServiceOutcome<StatisticsFieldInstance> loadStatisticsFieldInstance(RapidView rapidView)
           
 StatisticsFieldConfig updateStatisticsField(com.atlassian.crowd.embedded.api.User user, ErrorCollection errors, RapidView rapidView, StatisticsFieldConfig statisticsField)
           
 
Methods inherited from interface com.atlassian.greenhopper.manager.GreenHopperCache
flushCache
 

Method Detail

getDefaultStatisticsFieldConfig

StatisticsFieldConfig getDefaultStatisticsFieldConfig()
Returns the default StatisticsFieldConfig to use.

Returns:
the instance

getAvailableStatisticsFieldConfigs

java.util.List<StatisticsFieldConfig> getAvailableStatisticsFieldConfigs()
Returns the list of StatisticsFieldConfigs which are available to be used in a RapidView.

Returns:
the list; never null.

getAvailableStatisticsFields

java.util.List<StatisticsFieldInstance> getAvailableStatisticsFields()
Returns the list of StatisticsFieldInstances which represent the available StatisticsFieldConfigs.

Returns:
the list; never null.
See Also:
getAvailableStatisticsFieldConfigs()

getInstanceOfField

@NotNull
ServiceOutcome<StatisticsFieldInstance> getInstanceOfField(StatisticsFieldConfig config)
Returns the StatisticsFieldInstance representing the specified StatisticsFieldConfig. If the config is somehow invalid, for example if the field in the config refers to a non-existent field, an instance will still be returned which is the minimal implementation of a StatisticsFieldInstance - that is, it contains only a reference to the config. In addition to this, an error is returned in the ServiceOutcome.

Parameters:
config - the configuration to construct the instance from
Returns:
the result; will always have a ServiceOutcome.getValue(), and sometimes ServiceOutcome.getErrors().

updateStatisticsField

@Transactional
StatisticsFieldConfig updateStatisticsField(com.atlassian.crowd.embedded.api.User user,
                                                          ErrorCollection errors,
                                                          RapidView rapidView,
                                                          StatisticsFieldConfig statisticsField)

loadStatisticsField

ServiceOutcome<StatisticsFieldConfig> loadStatisticsField(RapidView rapidView)

loadStatisticsFieldInstance

ServiceOutcome<StatisticsFieldInstance> loadStatisticsFieldInstance(RapidView rapidView)

invalidate

void invalidate(RapidView rapidView)


Copyright © 2007-2012 Atlassian. All Rights Reserved.