com.atlassian.bamboo.plugin.web

Interface PlanConfigurationUIPluginHelper

All Known Implementing Classes:

PlanConfigurationPluginUIHelperImpl

public interface PlanConfigurationUIPluginHelper

Method Summary

Modifier and Type	Method and Description
<T extends BuildConfigurationAwarePlugin> @NotNull Iterable<T>	getBuildConfigurationPlugins(@NotNull Plan plan, @NotNull Class<T> pluginClass) Find all installed plugins of a given class.
<T extends BuildConfigurationAwarePlugin> @NotNull Iterable<T>	getBuildConfigurationPlugins(@NotNull Plan plan, @NotNull Class<T> pluginClass, Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses) Find all installed plugins of a given class and module descriptor.
<T extends BuildConfigurationAwarePlugin> @NotNull String	getEditHtml(@NotNull BuildConfiguration buildConfiguration, @NotNull Plan plan, @NotNull Class<T> pluginClass) Generate html page from all plugin edit fragments.
<T extends BuildConfigurationAwarePlugin> @NotNull List<String>	getEditHtmlList(@NotNull BuildConfiguration buildConfiguration, @NotNull Plan plan, @NotNull Class<T> pluginClass, Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses) Generate list of html edit fragments for all plugins.
List<Class>	getModuleTypesOnJobPage()
<T extends BuildConfigurationAwarePlugin> @NotNull String	getViewHtml(@NotNull Plan plan, @NotNull Class<T> pluginClass) Generate html page from all plugin view fragments.
<T extends BuildConfigurationAwarePlugin> @NotNull List<String>	getViewHtmlList(@NotNull Plan plan, @NotNull Class<T> pluginClass, Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses) Generate list of html view fragments for all plugins.
boolean	isPluginApplicableTo(@NotNull BuildConfigurationAwarePlugin module, @NotNull ImmutablePlan immutablePlan) Return true if a plugin module should be displayed on given plan''s "Other" page.

Method Detail

getBuildConfigurationPlugins

@NotNull
<T extends BuildConfigurationAwarePlugin> @NotNull Iterable<T> getBuildConfigurationPlugins(@NotNull
                                                                                                     @NotNull Plan plan,
                                                                                                     @NotNull
                                                                                                     @NotNull Class<T> pluginClass)

Find all installed plugins of a given class. If plugins implement PlanConfigurationUiPlugin, plugins will be checked for applicability to the plan.

Parameters:

plan - Plan to be checked with plugins

pluginClass - requested plugin class

Returns:

Iterable of filtered plugins

getBuildConfigurationPlugins

@NotNull
<T extends BuildConfigurationAwarePlugin> @NotNull Iterable<T> getBuildConfigurationPlugins(@NotNull
                                                                                                     @NotNull Plan plan,
                                                                                                     @NotNull
                                                                                                     @NotNull Class<T> pluginClass,
                                                                                                     @NotNull
                                                                                                     Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses)

Find all installed plugins of a given class and module descriptor. If plugins implement PlanConfigurationUiPlugin, plugins will be checked for applicability to the plan.

Parameters:

plan - Plan to be checked with plugins

pluginClass - requested plugin class

moduleDescriptorsClasses - plugin descriptors

Returns:

Iterable of filtered plugins

getViewHtml

@NotNull
<T extends BuildConfigurationAwarePlugin> @NotNull String getViewHtml(@NotNull
                                                                               @NotNull Plan plan,
                                                                               @NotNull
                                                                               @NotNull Class<T> pluginClass)

Generate html page from all plugin view fragments.

Parameters:

plan - Plan to be used for HTML generation

pluginClass - requested plugin class

Returns:

Aggregated HTML page for view

getEditHtml

@NotNull
<T extends BuildConfigurationAwarePlugin> @NotNull String getEditHtml(@NotNull
                                                                               @NotNull BuildConfiguration buildConfiguration,
                                                                               @NotNull
                                                                               @NotNull Plan plan,
                                                                               @NotNull
                                                                               @NotNull Class<T> pluginClass)

Generate html page from all plugin edit fragments.

Parameters:

buildConfiguration - BuildConfiguration to be used for HTML generation

plan - Plan to be used for HTML generation

pluginClass - requested plugin class

Returns:

Aggregated HTML page for edit.

getViewHtmlList

@NotNull
<T extends BuildConfigurationAwarePlugin> @NotNull List<String> getViewHtmlList(@NotNull
                                                                                         @NotNull Plan plan,
                                                                                         @NotNull
                                                                                         @NotNull Class<T> pluginClass,
                                                                                         @NotNull
                                                                                         Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses)

Generate list of html view fragments for all plugins.

Parameters:

plan - Plan to be used for HTML generation

pluginClass - requested plugin class

moduleDescriptorsClasses - plugin descriptors

Returns:

HTML fragments for view.

getEditHtmlList

@NotNull
<T extends BuildConfigurationAwarePlugin> @NotNull List<String> getEditHtmlList(@NotNull
                                                                                         @NotNull BuildConfiguration buildConfiguration,
                                                                                         @NotNull
                                                                                         @NotNull Plan plan,
                                                                                         @NotNull
                                                                                         @NotNull Class<T> pluginClass,
                                                                                         @NotNull
                                                                                         Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses)

Generate list of html edit fragments for all plugins.

Parameters:

buildConfiguration - BuildConfiguration to be used for HTML generation

plan - Plan to be used for HTML generation

pluginClass - requested plugin class

moduleDescriptorsClasses - plugin descriptors

Returns:

HTML fragments for edit

isPluginApplicableTo

boolean isPluginApplicableTo(@NotNull
                             @NotNull BuildConfigurationAwarePlugin module,
                             @NotNull
                             @NotNull ImmutablePlan immutablePlan)

Return true if a plugin module should be displayed on given plan''s "Other" page.

getModuleTypesOnJobPage

List<Class> getModuleTypesOnJobPage()