com.atlassian.greenhopper.service.statistics
Interface MarkerService

All Known Implementing Classes:

MarkerServiceImpl

public interface MarkerService

Field Summary

static java.lang.String

SERVICE Service identifier to be used for dependency injection.

Method Summary

void	clearCache() Clears out any internal caches.
java.util.Map<java.lang.String,java.util.Set<Marker>>	getCompiledMarkers(com.opensymphony.user.User user, XProject xproject, ViewDefinition view, IssueField sortField, java.lang.String key, com.atlassian.query.Query query) When markers get "compiled", they're getting linked to the issue that defines their position, based on the marker configuration (max value).
Marker	getMarker(XProject xproject, ViewDefinition view, java.lang.String key, WatchedField watchedField)
boolean	isMarkerEnabled(XProject xproject, ViewDefinition view, WatchedField watchedField) Check if the marker is enabled, without having to load the whole marker.
Marker	setMarkerToIssue(com.opensymphony.user.User user, XProject xproject, ViewDefinition view, java.lang.String key, WatchedField watchedField, com.atlassian.jira.issue.Issue forcedPosition, com.atlassian.query.Query query, ErrorCollection errorCollection) Position the marker at the given issue.
Marker	setMarkerToValue(com.opensymphony.user.User user, XProject xproject, ViewDefinition view, java.lang.String key, WatchedField watchedField, java.lang.String forcedValue, com.atlassian.query.Query query, ErrorCollection errorCollection) Set the marker to a particular value
void	toggleMarker(XProject xproject, ViewDefinition view, WatchedField watchedField) Switch the marker on/off

Field Detail

SERVICE

static final java.lang.String SERVICE

Service identifier to be used for dependency injection.

See Also:

Constant Field Values

Method Detail

getMarker

Marker getMarker(XProject xproject,
                 ViewDefinition view,
                 java.lang.String key,
                 WatchedField watchedField)

Parameters:

key - : The key is part of the propertySet key that is used to identify the record. This could be as simple as a boardId, but also include a secondary filter (like the version on the assignee board).

Returns:

the marker for the given parameters. If there's no data present, the marker will fall back to defaults. It is never null.

toggleMarker

void toggleMarker(XProject xproject,
                  ViewDefinition view,
                  WatchedField watchedField)

Switch the marker on/off

isMarkerEnabled

boolean isMarkerEnabled(XProject xproject,
                        ViewDefinition view,
                        WatchedField watchedField)

Check if the marker is enabled, without having to load the whole marker.

getCompiledMarkers

java.util.Map<java.lang.String,java.util.Set<Marker>> getCompiledMarkers(com.opensymphony.user.User user,
                                                                         XProject xproject,
                                                                         ViewDefinition view,
                                                                         IssueField sortField,
                                                                         java.lang.String key,
                                                                         com.atlassian.query.Query query)

When markers get "compiled", they're getting linked to the issue that defines their position, based on the marker configuration (max value).

Returns:

the markers that are positioned at the given issues (map key = issueKey)

setMarkerToIssue

Marker setMarkerToIssue(com.opensymphony.user.User user,
                        XProject xproject,
                        ViewDefinition view,
                        java.lang.String key,
                        WatchedField watchedField,
                        com.atlassian.jira.issue.Issue forcedPosition,
                        com.atlassian.query.Query query,
                        ErrorCollection errorCollection)

Position the marker at the given issue.

setMarkerToValue

Marker setMarkerToValue(com.opensymphony.user.User user,
                        XProject xproject,
                        ViewDefinition view,
                        java.lang.String key,
                        WatchedField watchedField,
                        java.lang.String forcedValue,
                        com.atlassian.query.Query query,
                        ErrorCollection errorCollection)

Set the marker to a particular value

clearCache

void clearCache()

Clears out any internal caches.