Package com.atlassian.bamboo.capability

Interface CapabilityConfiguratorPluginModule

All Superinterfaces:

BambooPluginModule, InitablePluginModule

All Known Implementing Classes:

AbstractCapabilityConfiguratorPluginModule, Maven2CapabilityConfigurator

public interface CapabilityConfiguratorPluginModule
extends InitablePluginModule

Module descriptor for Capability Configurator plugin point

Method Summary

Modifier and Type	Method	Description
void	customizeConfiguration(@NotNull org.apache.commons.configuration.Configuration capability, @NotNull ActionParametersMap parameters)	Customize capability configuration from action parameters.
@NotNull String	getEditHtml(@NotNull org.apache.commons.configuration.Configuration capability)	Get edit HTML for capability configuration.
@NotNull String	getViewHtml(@NotNull org.apache.commons.configuration.Configuration capability)	Get view HTML for capability configuration.
boolean	providesEdit(@NotNull String capabilityKey)	Provide information if capability's configuration can be edited by this module.
boolean	providesView(@NotNull String capabilityKey)	Provide information if capability's configuration can be viewed by this module.

Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule

init

Method Detail

providesEdit

boolean providesEdit(@NotNull
                     @NotNull String capabilityKey)

Provide information if capability's configuration can be edited by this module.

Parameters:

capabilityKey - Capability key to be verified

Returns:

True if configuration for capability can be edited with this module, false otherwise.

getEditHtml

@NotNull
@NotNull String getEditHtml(@NotNull
                            @NotNull org.apache.commons.configuration.Configuration capability)

Get edit HTML for capability configuration.

Parameters:

capability - Configuration object

Returns:

HTML snippet

providesView

boolean providesView(@NotNull
                     @NotNull String capabilityKey)

Provide information if capability's configuration can be viewed by this module.

Parameters:

capabilityKey - Capability key to be verified

Returns:

True if configuration for capability can be viewed with this module, false otherwise.

getViewHtml

@NotNull
@NotNull String getViewHtml(@NotNull
                            @NotNull org.apache.commons.configuration.Configuration capability)

Get view HTML for capability configuration.

Parameters:

capability - Configuration object

Returns:

HTML snippet

customizeConfiguration

void customizeConfiguration(@NotNull
                            @NotNull org.apache.commons.configuration.Configuration capability,
                            @NotNull
                            @NotNull ActionParametersMap parameters)

Customize capability configuration from action parameters.

Parameters:

capability - Configuration object

parameters - Action parameters