com.atlassian.greenhopper.service.statistics
Interface WatchedFieldService

All Known Implementing Classes:

WatchedFieldServiceImpl

public interface WatchedFieldService

Encapsulates watched field information. Use this instead of going directly to the Configuration! Note regarding TempKeyGen: This will map the different views to the boardType the search should work on "" is VersionBoard (which is also used by the TaskBoard), the other two existing are ComponentBoard and AssigneeBoard currently

Field Summary

static java.lang.String

SERVICE Service identifier to be used for dependency injection.

Method Summary

ErrorCollection	addWatchedField(com.atlassian.crowd.embedded.api.User user, ViewDefinition view, Configuration configuration, java.lang.String fieldId) Add a field to the watched fields.
java.util.Set<IssueField>	getAllAvailableWatchedFields(com.atlassian.crowd.embedded.api.User user, ViewDefinition view, Configuration configuration) Get all available watched fields for a given boardType and configuration Note that this method won't return IssueFields already contained in watched fields.
WatchedField	getWatchedField(com.atlassian.crowd.embedded.api.User user, ViewDefinition view, Configuration configuration, java.lang.String fieldId) Get a watched field given its field id
java.util.Set<WatchedField>	getWatchedFields(com.atlassian.crowd.embedded.api.User user, ViewDefinition view, Configuration configuration) Get the configured watched fields for a given boardType and configuration
boolean	isWatchedField(com.atlassian.crowd.embedded.api.User user, ViewDefinition view, Configuration configuration, IssueField issueField) Is the passed in IssueField a watched field?
ErrorCollection	removeWatchedField(com.atlassian.crowd.embedded.api.User user, ViewDefinition view, Configuration configuration, java.lang.String fieldId) Remove a field from the watched fields.

Field Detail

SERVICE

static final java.lang.String SERVICE

Service identifier to be used for dependency injection.

See Also:

Constant Field Values

Method Detail

getAllAvailableWatchedFields

java.util.Set<IssueField> getAllAvailableWatchedFields(com.atlassian.crowd.embedded.api.User user,
                                                       ViewDefinition view,
                                                       Configuration configuration)

Get all available watched fields for a given boardType and configuration Note that this method won't return IssueFields already contained in watched fields.

getWatchedFields

java.util.Set<WatchedField> getWatchedFields(com.atlassian.crowd.embedded.api.User user,
                                             ViewDefinition view,
                                             Configuration configuration)

Get the configured watched fields for a given boardType and configuration

addWatchedField

ErrorCollection addWatchedField(com.atlassian.crowd.embedded.api.User user,
                                ViewDefinition view,
                                Configuration configuration,
                                java.lang.String fieldId)

Add a field to the watched fields.

removeWatchedField

ErrorCollection removeWatchedField(com.atlassian.crowd.embedded.api.User user,
                                   ViewDefinition view,
                                   Configuration configuration,
                                   java.lang.String fieldId)

Remove a field from the watched fields.

getWatchedField

WatchedField getWatchedField(com.atlassian.crowd.embedded.api.User user,
                             ViewDefinition view,
                             Configuration configuration,
                             java.lang.String fieldId)

Get a watched field given its field id

isWatchedField

boolean isWatchedField(com.atlassian.crowd.embedded.api.User user,
                       ViewDefinition view,
                       Configuration configuration,
                       IssueField issueField)

Is the passed in IssueField a watched field?