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

void	customizeConfiguration(org.apache.commons.configuration.Configuration capability, ActionParametersMap parameters) Customize capability configuration from action parameters.
java.lang.String	getEditHtml(org.apache.commons.configuration.Configuration capability) Get edit HTML for capability configuration.
java.lang.String	getViewHtml(org.apache.commons.configuration.Configuration capability) Get view HTML for capability configuration.
boolean	providesEdit(java.lang.String capabilityKey) Provide information if capability's configuration can be edited by this module.
boolean	providesView(java.lang.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
                     java.lang.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
java.lang.String getEditHtml(@NotNull
                                     org.apache.commons.configuration.Configuration capability)

Get edit HTML for capability configuration.

Parameters:

capability - Configuration object

Returns:

HTML snippet

providesView

boolean providesView(@NotNull
                     java.lang.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
java.lang.String getViewHtml(@NotNull
                                     org.apache.commons.configuration.Configuration capability)

Get view HTML for capability configuration.

Parameters:

capability - Configuration object

Returns:

HTML snippet

customizeConfiguration

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

Customize capability configuration from action parameters.

Parameters:

capability - Configuration object

parameters - Action parameters