com.atlassian.greenhopper.sampledata

Interface SampleDataGenerator

All Known Implementing Classes:

SampleDataGeneratorImpl

public interface SampleDataGenerator

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<RapidView>	createRapidViewWithProjects(String rapidViewName, RapidViewPreset rapidViewPreset, List<com.atlassian.jira.project.Project> projects) Creates a rapid view for a list of projects
ServiceOutcome<com.atlassian.jira.project.Project>	createSampleKanbanData(String projectKey, String projectName, io.atlassian.fugue.Option<String> projectLeadUserName) Creates a kanban project and fills it with sample data
ServiceOutcome<com.atlassian.jira.project.Project>	createSampleScrumData(String projectKey, String projectName, io.atlassian.fugue.Option<String> projectLeadUserName) Creates a scrum project and fills it with sample data
ServiceOutcome<com.atlassian.jira.project.Project>	importSampleDataFromUrl(String projectKey, String projectName, io.atlassian.fugue.Option<String> projectLeadUserName, SimplifiedWorkflowPresets projectWorkflow, URL sampleDataUrl, ProjectType projectType) Creates a project from data contained in a JSON file

Method Detail

createSampleKanbanData

ServiceOutcome<com.atlassian.jira.project.Project> createSampleKanbanData(String projectKey,
                                                                          String projectName,
                                                                          io.atlassian.fugue.Option<String> projectLeadUserName)

Creates a kanban project and fills it with sample data

Parameters:

projectKey -

projectName -

projectLeadUserName - an Option which can contain the user name of the lead for the project to be created

Returns:

an outcome which will either have the project or errors

createSampleScrumData

ServiceOutcome<com.atlassian.jira.project.Project> createSampleScrumData(String projectKey,
                                                                         String projectName,
                                                                         io.atlassian.fugue.Option<String> projectLeadUserName)

Creates a scrum project and fills it with sample data

Parameters:

projectKey - the key for the project to be created

projectName - the name for the project to be created

projectLeadUserName - an Option which can contain the user name of the lead for the project to be created

Returns:

an outcome which will either have the project or errors

importSampleDataFromUrl

ServiceOutcome<com.atlassian.jira.project.Project> importSampleDataFromUrl(String projectKey,
                                                                           String projectName,
                                                                           io.atlassian.fugue.Option<String> projectLeadUserName,
                                                                           SimplifiedWorkflowPresets projectWorkflow,
                                                                           URL sampleDataUrl,
                                                                           ProjectType projectType)

Creates a project from data contained in a JSON file

Parameters:

projectKey - the key for the project to be created

projectName - the name for the project to be created

projectLeadUserName - an Option which can contain the user name of the lead for the project to be created

projectWorkflow - the simplified workflow preset to use for the project to be created

sampleDataUrl - the URL to the JSON file containing the sample data to import

projectType - the project type

Returns:

an outcome which will either have the project or errors

createRapidViewWithProjects

ServiceOutcome<RapidView> createRapidViewWithProjects(String rapidViewName,
                                                      RapidViewPreset rapidViewPreset,
                                                      List<com.atlassian.jira.project.Project> projects)

Creates a rapid view for a list of projects

Parameters:

rapidViewName - the name of the rapid view to be created

rapidViewPreset - the column preset for the rapid view to be created

projects - the projects to be shown on the rapid view