com.atlassian.bamboo.build.creation
Interface PlanConfigHelper

All Known Implementing Classes:
BuilderConfigHelper, BuildStrategyConfigHelper, RepositoryConfigHelper, WebRepositoryConfigHelper

public interface PlanConfigHelper

A generic interface to perform manipulations to the Plan Configuration (BuildConfiguration)


Method Summary
 void addDefaultsToConfig(BuildConfiguration buildConfiguration)
          Adds default values for all possible selections, esp preparing for display on the UI
 void cleanConfig(BuildConfiguration buildConfiguration)
          Cleans out any data from the build config, not required by the selected option.
 void performPostActionsOnConfig(BuildConfiguration buildConfiguration, Plan plan)
          Performs any miscellaneous actions required before saving the plan.
 void prepareConfig(BuildConfiguration buildConfiguration)
          Prepare the build configuration for validation.
 void validateConfig(com.opensymphony.xwork.ValidationAware validationAware, BuildConfiguration buildConfiguration)
          Validates the configuration for a plan.
 

Method Detail

addDefaultsToConfig

void addDefaultsToConfig(@NotNull
                         BuildConfiguration buildConfiguration)
Adds default values for all possible selections, esp preparing for display on the UI

Parameters:
buildConfiguration - - to add defaults to

validateConfig

void validateConfig(@NotNull
                    com.opensymphony.xwork.ValidationAware validationAware,
                    @NotNull
                    BuildConfiguration buildConfiguration)
Validates the configuration for a plan. Adds any errors to the validationAware object

Parameters:
validationAware - - normally the action calling this
buildConfiguration - - the configuration to validate

prepareConfig

void prepareConfig(@NotNull
                   BuildConfiguration buildConfiguration)
Prepare the build configuration for validation. Performs required manual manipulations on the build config.

Parameters:
buildConfiguration - to manipulate

cleanConfig

void cleanConfig(@NotNull
                 BuildConfiguration buildConfiguration)
Cleans out any data from the build config, not required by the selected option.

Parameters:
buildConfiguration - - to clean

performPostActionsOnConfig

void performPostActionsOnConfig(@NotNull
                                BuildConfiguration buildConfiguration,
                                @NotNull
                                Plan plan)
Performs any miscellaneous actions required before saving the plan. Is aware of the currently selected option.

Parameters:
buildConfiguration - - of the current configuration
plan - - the current plan


Copyright © 2010 Atlassian. All Rights Reserved.