com.atlassian.bamboo.v2.build.configuration
Interface BuildConfigurationUIPlugin

All Superinterfaces:
BambooPluginModule, BuildConfigurationAwarePlugin, CustomBuildDefinitionTransformer, InitablePluginModule, RenderableBuildConfiguration
All Known Subinterfaces:
DependenciesBuildConfigurationPlugin, MiscellaneousBuildConfigurationPlugin
All Known Implementing Classes:
AutomaticDependencyManagementPlugin, BuildExpiryPerPlanPlugin, ConcurrentBuildsPlanConfigurationPlugin

public interface BuildConfigurationUIPlugin
extends BuildConfigurationAwarePlugin, CustomBuildDefinitionTransformer

This is not intended to be used directly. One of the specialized marker interfaces should be used directly.


Method Summary
 boolean isApplicableTo(Plan plan)
          Checks if the plugin is applicable to a plan.
 boolean isConfigurationMissing(BuildConfiguration buildConfiguration)
          Checks if BuildConfiguration objects contains plugin's configuration values.
 
Methods inherited from interface com.atlassian.bamboo.v2.build.BuildConfigurationAwarePlugin
addDefaultValues, prepareConfigObject, validate
 
Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule
init
 
Methods inherited from interface com.atlassian.bamboo.v2.build.RenderableBuildConfiguration
getEditHtml, getViewHtml
 
Methods inherited from interface com.atlassian.bamboo.plugin.module.ext.CustomBuildDefinitionTransformer
transformBuildDefinition
 

Method Detail

isConfigurationMissing

boolean isConfigurationMissing(@NotNull
                               BuildConfiguration buildConfiguration)
Checks if BuildConfiguration objects contains plugin's configuration values. Should return true if call to addDefaultValues() is necessary to initialize BuildConfiguration.

Parameters:
buildConfiguration - BuildConfiguration object
Returns:
true if configuration is not present in BuildConfiguration and should be set to defaults

isApplicableTo

boolean isApplicableTo(@NotNull
                       Plan plan)
Checks if the plugin is applicable to a plan. Typical implementation is to check plan's type (chain, build, job).

Parameters:
plan - Plan to be verified
Returns:
true if particular configuration is applicable to input plan


Copyright © 2011 Atlassian. All Rights Reserved.