com.atlassian.greenhopper.service.rapid.view.color
Interface CardColorQueryService

All Known Implementing Classes:

CardColorQueryServiceImpl

public interface CardColorQueryService

Encapsulates the card colors querying logic

Method Summary

ServiceOutcome<RapidIssueEntryCallbackComponent>	createCardColorIssueEntryCallback(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, CardColorStrategy cardColorStrategy) Get a RapidIssueEntryCallbackComponent for a given rapidView and cardColorStrategy.
ServiceOutcome<CardColor>	getCardColorForIssue(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, CardColorStrategy cardColorStrategy, com.atlassian.jira.issue.Issue issue) Get the card color for a single issue
ServiceOutcome<java.util.Map<java.lang.Long,CardColor>>	getCardColorsForQuery(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, CardColorStrategy cardColorStrategy, com.atlassian.query.Query query, int maxVisitedIssues) Collect the card colors for all issues matching a given query.
ServiceOutcome<java.lang.Void>	queryAndAttributeColorSettingsForBoard(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, CardColorStrategy cardColorStrategy) Execute a search for the given strategy to ensure all possible values have a color
boolean	supportsIssueDataCallback(CardColorStrategy strategy) Can the card color be extracted directly from the issue index.

Method Detail

supportsIssueDataCallback

boolean supportsIssueDataCallback(CardColorStrategy strategy)

Can the card color be extracted directly from the issue index. This is true for all types except for jql (which requires executing separate queries for each color)

getCardColorsForQuery

ServiceOutcome<java.util.Map<java.lang.Long,CardColor>> getCardColorsForQuery(com.atlassian.crowd.embedded.api.User user,
                                                                              RapidView rapidView,
                                                                              CardColorStrategy cardColorStrategy,
                                                                              com.atlassian.query.Query query,
                                                                              int maxVisitedIssues)

Collect the card colors for all issues matching a given query.

Parameters:

maxVisitedIssues - the maximum number of issues to visit. This is mainly an optimization for a single issue to stop when we found a matching color. Only use when the number of issues matched by the query is known

getCardColorForIssue

ServiceOutcome<CardColor> getCardColorForIssue(com.atlassian.crowd.embedded.api.User user,
                                               RapidView rapidView,
                                               CardColorStrategy cardColorStrategy,
                                               com.atlassian.jira.issue.Issue issue)

Get the card color for a single issue

createCardColorIssueEntryCallback

ServiceOutcome<RapidIssueEntryCallbackComponent> createCardColorIssueEntryCallback(com.atlassian.crowd.embedded.api.User user,
                                                                                   RapidView rapidView,
                                                                                   CardColorStrategy cardColorStrategy)

Get a RapidIssueEntryCallbackComponent for a given rapidView and cardColorStrategy. Not all strategies allow to be fetched as a simple IssueDataCallback, so check supportsIssueDataCallback before calling this method. In case the strategy doesn't support a callback, use the appropriate query method below

queryAndAttributeColorSettingsForBoard

ServiceOutcome<java.lang.Void> queryAndAttributeColorSettingsForBoard(com.atlassian.crowd.embedded.api.User user,
                                                                      RapidView rapidView,
                                                                      CardColorStrategy cardColorStrategy)

Execute a search for the given strategy to ensure all possible values have a color