Package com.atlassian.bamboo.build.creation

Interface JobCreationService

All Superinterfaces:

PlanCreationService

All Known Implementing Classes:

JobCreationServiceImpl

public interface JobCreationService
extends PlanCreationService

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.build.creation.PlanCreationService

PlanCreationService.EnablePlan

Field Summary

Fields inherited from interface com.atlassian.bamboo.build.creation.PlanCreationService

EXISTING_PROJECT_KEY, NEW_PROJECT_MARKER, PROJECT_DESCRIPTION, PROJECT_KEY, PROJECT_NAME

Method Summary

Modifier and Type	Method	Description
List<PlanKey>	createJobAndBranches(@NotNull BuildConfiguration buildConfiguration, @NotNull ActionParametersMap actionParametersMap, @NotNull PlanCreationService.EnablePlan ifPlanEnabled)
String	createPlan(@NotNull BuildConfiguration buildConfiguration, @NotNull ActionParametersMap actionParametersMap, @NotNull PlanCreationService.EnablePlan enabled)	Deprecated. since 4.0 use @{link #createJobAndBranches}
String	createSingleJob(BuildConfiguration buildConfiguration, ActionParametersMap clonedActionParametersMap, PlanCreationService.EnablePlan planEnabled)
Job	getNewInstance()

Methods inherited from interface com.atlassian.bamboo.build.creation.PlanCreationService

getBuildConfigurationWithDefaults, savePlan, triggerCreationCompleteEvents, validatePlan

Method Detail

getNewInstance

Job getNewInstance()

Specified by:

getNewInstance in interface PlanCreationService

Returns:

A new plan instance, concrete type determined by implementation classes

createSingleJob

String createSingleJob(BuildConfiguration buildConfiguration,
                       ActionParametersMap clonedActionParametersMap,
                       PlanCreationService.EnablePlan planEnabled)
                throws PlanCreationDeniedException,
                       PlanCreationException

Throws:

PlanCreationDeniedException

PlanCreationException

createPlan

@Deprecated
String createPlan(@NotNull
                  @NotNull BuildConfiguration buildConfiguration,
                  @NotNull
                  @NotNull ActionParametersMap actionParametersMap,
                  @NotNull
                  @NotNull PlanCreationService.EnablePlan enabled)
           throws PlanCreationDeniedException,
                  PlanCreationException

Deprecated.

since 4.0 use @{link #createJobAndBranches}

This method will also create the job branches

Specified by:

createPlan in interface PlanCreationService

Parameters:

buildConfiguration - of the plan to create

actionParametersMap - containing any other required params NOT in the buildConfiguration

enabled - whether the plan should start enabled or disabled

Returns:

the full key of the created plan

Throws:

PlanCreationDeniedException - if plan creation fails because you already have too many plans.

PlanCreationException - if plan creation fails for any other reason

createJobAndBranches

List<PlanKey> createJobAndBranches(@NotNull
                                   @NotNull BuildConfiguration buildConfiguration,
                                   @NotNull
                                   @NotNull ActionParametersMap actionParametersMap,
                                   @NotNull
                                   @NotNull PlanCreationService.EnablePlan ifPlanEnabled)
                            throws PlanCreationDeniedException,
                                   PlanCreationException

Throws:

PlanCreationDeniedException

PlanCreationException