com.atlassian.greenhopper.service.rapid

Interface RapidViewClauseService

All Known Implementing Classes:

RapidViewClauseServiceImpl

public interface RapidViewClauseService

Provides access to clauses used by different parts of the RapidBoard. Currently all clauses are hardcoded, but eventually some will be configurable. This service replaces the previous concept of SubQueries, as that concept doesn't carry far enough

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RapidViewClauseService.ClauseType

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<ClauseToAdd>	getClauseForBuilder(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, RapidViewClauseService.ClauseType clauseType) Applies a clause of given type to the passed builder
ServiceOutcome<ClauseToAdd>	getDefinitionOfDoneClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView) Returns the definition on done clause.
ServiceOutcome<ClauseToAdd>	getDefinitionOfNotDoneClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView) Returns the definition on not done clause.
ServiceOutcome<ClauseToAdd>	getKanbanPlanModeClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView) Returns the kanban plan mode clause.
ServiceOutcome<ClauseToAdd>	getPlanModeActiveSprintsClause(RapidView rapidView) Returns the plan mode with active sprints clause.
ServiceOutcome<ClauseToAdd>	getPlanModeClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView) Returns the plan mode clause.
ServiceOutcome<ClauseToAdd>	getPlanModeIssuesClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView) Returns the plan mode issues clause.
ServiceOutcome<ClauseToAdd>	getPlanModeWithSubtasksClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView) Returns the plan mode with subtasks clause.
ServiceOutcome<ClauseToAdd>	getSprintReportModeClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView) Returns the sprint report mode clause.
ServiceOutcome<ClauseToAdd>	getVisibleEpicsClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView) Returns the visible epics clause.
ServiceOutcome<ClauseToAdd>	getWorkModeClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView) Returns the work mode clause.

Method Detail

getClauseForBuilder

@Nonnull
ServiceOutcome<ClauseToAdd> getClauseForBuilder(com.atlassian.jira.user.ApplicationUser user,
                                                         RapidView rapidView,
                                                         RapidViewClauseService.ClauseType clauseType)

Applies a clause of given type to the passed builder

getPlanModeIssuesClause

@Nonnull
ServiceOutcome<ClauseToAdd> getPlanModeIssuesClause(com.atlassian.jira.user.ApplicationUser user,
                                                             RapidView rapidView)

Returns the plan mode issues clause. Equivalent of using getClauseForBuilder(user, rapidView, ClauseType.PLAN_MODE_ISSUES)

getDefinitionOfNotDoneClause

@Nonnull
ServiceOutcome<ClauseToAdd> getDefinitionOfNotDoneClause(com.atlassian.jira.user.ApplicationUser user,
                                                                  RapidView rapidView)

Returns the definition on not done clause. Equivalent of using getClauseForBuilder(user, rapidView, ClauseType.DEFINITION_OF_NOT_DONE)

getDefinitionOfDoneClause

@Nonnull
ServiceOutcome<ClauseToAdd> getDefinitionOfDoneClause(com.atlassian.jira.user.ApplicationUser user,
                                                               RapidView rapidView)

Returns the definition on done clause. Equivalent of using getClauseForBuilder(user, rapidView, ClauseType.DEFINITION_OF_DONE)

getPlanModeClause

@Nonnull
ServiceOutcome<ClauseToAdd> getPlanModeClause(com.atlassian.jira.user.ApplicationUser user,
                                                       RapidView rapidView)

Returns the plan mode clause. Equivalent of using getClauseForBuilder(user, rapidView, ClauseType.PLAN_MODE)

getKanbanPlanModeClause

@Nonnull
ServiceOutcome<ClauseToAdd> getKanbanPlanModeClause(com.atlassian.jira.user.ApplicationUser user,
                                                             RapidView rapidView)

Returns the kanban plan mode clause. Basically ensuring only issues with statuses mapped to either backlog or selected for development are included.

getPlanModeWithSubtasksClause

@Nonnull
ServiceOutcome<ClauseToAdd> getPlanModeWithSubtasksClause(com.atlassian.jira.user.ApplicationUser user,
                                                                   RapidView rapidView)

Returns the plan mode with subtasks clause. Equivalent of using getClauseForBuilder(user, rapidView, ClauseType.PLAN_MODE_WITH_SUBTASKS)

getPlanModeActiveSprintsClause

@Nonnull
ServiceOutcome<ClauseToAdd> getPlanModeActiveSprintsClause(RapidView rapidView)

Returns the plan mode with active sprints clause. Equivalent of using getClauseForBuilder(user, rapidView, ClauseType.PLAN_MODE_ACTIVE_SPRINTS)

getWorkModeClause

@Nonnull
ServiceOutcome<ClauseToAdd> getWorkModeClause(com.atlassian.jira.user.ApplicationUser user,
                                                       RapidView rapidView)

Returns the work mode clause. Equivalent of using getClauseForBuilder(user, rapidView, ClauseType.WORK_MODE)

getSprintReportModeClause

@Nonnull
ServiceOutcome<ClauseToAdd> getSprintReportModeClause(com.atlassian.jira.user.ApplicationUser user,
                                                               RapidView rapidView)

Returns the sprint report mode clause. Equivalent of using getClauseForBuilder(user, rapidView, ClauseType.SPRINT_REPORT_MODE)

getVisibleEpicsClause

@Nonnull
ServiceOutcome<ClauseToAdd> getVisibleEpicsClause(com.atlassian.jira.user.ApplicationUser user,
                                                           RapidView rapidView)

Returns the visible epics clause. Equivalent of using getClauseForBuilder(user, rapidView, ClauseType.VISIBLE_EPICS)