com.atlassian.greenhopper.api.rapid.view
Interface RapidViewCreationService

public interface RapidViewCreationService

GreenHopper API service for creation and manipulation of rapid views

Method Summary

java.lang.Long	createNewRapidView(com.atlassian.crowd.embedded.api.User user, java.lang.String name, long filterId, com.atlassian.jira.util.ErrorCollection errors) Creates a new rapid view with default column mappings, swimlanes and quick filters.
void	setQuickFilters(com.atlassian.crowd.embedded.api.User user, long rapidViewId, java.util.List<QuickFilter> quickFilters, com.atlassian.jira.util.ErrorCollection errors)
void	setStatisticsField(com.atlassian.crowd.embedded.api.User user, long rapidViewId, StatisticsField statisticsField, com.atlassian.jira.util.ErrorCollection errors)
void	setStatusMappings(com.atlassian.crowd.embedded.api.User user, long rapidViewId, java.util.List<Column> columns, com.atlassian.jira.util.ErrorCollection errors)
void	setSwimlanes(com.atlassian.crowd.embedded.api.User user, long rapidViewId, java.util.List<Swimlane> swimlanes, com.atlassian.jira.util.ErrorCollection errors)

Method Detail

createNewRapidView

java.lang.Long createNewRapidView(com.atlassian.crowd.embedded.api.User user,
                                  java.lang.String name,
                                  long filterId,
                                  com.atlassian.jira.util.ErrorCollection errors)

Creates a new rapid view with default column mappings, swimlanes and quick filters.

Parameters:

user - the user creating the rapid view

name - the name of the new rapid view

filterId - the id of the filter to be used by the new rapid view

errors - an ErrorCollection to be filled on error

Returns:

the id of the new rapid view or null in case of error, in which case errors is non-empty.

setStatusMappings

void setStatusMappings(com.atlassian.crowd.embedded.api.User user,
                       long rapidViewId,
                       java.util.List<Column> columns,
                       com.atlassian.jira.util.ErrorCollection errors)

Parameters:

user - the user editing the rapid view

rapidViewId - id of the rapid view to change status mappings for

columns - a list of Column objects representing the mappings of a column in the rapid view

errors - an ErrorCollection to be filled on error

setQuickFilters

void setQuickFilters(com.atlassian.crowd.embedded.api.User user,
                     long rapidViewId,
                     java.util.List<QuickFilter> quickFilters,
                     com.atlassian.jira.util.ErrorCollection errors)

Parameters:

user - the user editing the rapid view

rapidViewId - id of the rapid view to change the quick filters for

quickFilters - a list of QuickFilter objects representing the new quick filters for the rapid view

errors - an ErrorCollection to be filled on error

setSwimlanes

void setSwimlanes(com.atlassian.crowd.embedded.api.User user,
                  long rapidViewId,
                  java.util.List<Swimlane> swimlanes,
                  com.atlassian.jira.util.ErrorCollection errors)

Parameters:

user - the user editing the rapid view

rapidViewId - id of the rapid view to change the swimlanes for

swimlanes - a list of Swimlane objects representing the new swimlanes. The default swimlane will be added automatically

errors - an ErrorCollection to be filled on error

setStatisticsField

void setStatisticsField(com.atlassian.crowd.embedded.api.User user,
                        long rapidViewId,
                        StatisticsField statisticsField,
                        com.atlassian.jira.util.ErrorCollection errors)

Parameters:

user - the user editing the rapid view

rapidViewId - id of the rapid view to change statistics field for

statisticsField - the StatisticsFieldConfig to set the rapid view to. Currently only supports issue count or no statistics field. more fields will be supported in the future

errors - an ErrorCollection to be filled on error