com.atlassian.bamboo.plugin.web
Interface PlanConfigurationUIPluginHelper

All Known Implementing Classes:
PlanConfigurationPluginUIHelperImpl

public interface PlanConfigurationUIPluginHelper


Method Summary
<T extends BuildConfigurationAwarePlugin>
java.lang.Iterable<T>
getBuildConfigurationPlugins(Plan plan, java.lang.Class<T> pluginClass)
          Find all installed plugins of a given class.
<T extends BuildConfigurationAwarePlugin>
java.lang.Iterable<T>
getBuildConfigurationPlugins(Plan plan, java.lang.Class<T> pluginClass, java.lang.Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses)
          Find all installed plugins of a given class and module descriptor.
<T extends BuildConfigurationAwarePlugin>
java.lang.String
getEditHtml(BuildConfiguration buildConfiguration, Plan plan, java.lang.Class<T> pluginClass)
          Generate html page from all plugin edit fragments.
<T extends BuildConfigurationAwarePlugin>
java.util.List<java.lang.String>
getEditHtmlList(BuildConfiguration buildConfiguration, Plan plan, java.lang.Class<T> pluginClass, java.lang.Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses)
          Generate list of html edit fragments for all plugins.
<T extends BuildConfigurationAwarePlugin>
java.lang.String
getViewHtml(Plan plan, java.lang.Class<T> pluginClass)
          Generate html page from all plugin view fragments.
<T extends BuildConfigurationAwarePlugin>
java.util.List<java.lang.String>
getViewHtmlList(Plan plan, java.lang.Class<T> pluginClass, java.lang.Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses)
          Generate list of html view fragments for all plugins.
 

Method Detail

getBuildConfigurationPlugins

@NotNull
<T extends BuildConfigurationAwarePlugin> java.lang.Iterable<T> getBuildConfigurationPlugins(@NotNull
                                                                                                     Plan plan,
                                                                                                     @NotNull
                                                                                                     java.lang.Class<T> pluginClass)
Find all installed plugins of a given class. If plugins implement BuildConfigurationUIPlugin, 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> java.lang.Iterable<T> getBuildConfigurationPlugins(@NotNull
                                                                                                     Plan plan,
                                                                                                     @NotNull
                                                                                                     java.lang.Class<T> pluginClass,
                                                                                                     @NotNull
                                                                                                     java.lang.Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses)
Find all installed plugins of a given class and module descriptor. If plugins implement BuildConfigurationUIPlugin, plugins will be checked for applicability to the plan.

Parameters:
plan - Plan to be checked with plugins
pluginClass - requested plugin class
moduleDescriptorClasses - plugin descriptors
Returns:
Iterable of filtered plugins

getViewHtml

@NotNull
<T extends BuildConfigurationAwarePlugin> java.lang.String getViewHtml(@NotNull
                                                                               Plan plan,
                                                                               @NotNull
                                                                               java.lang.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> java.lang.String getEditHtml(@NotNull
                                                                               BuildConfiguration buildConfiguration,
                                                                               @NotNull
                                                                               Plan plan,
                                                                               @NotNull
                                                                               java.lang.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> java.util.List<java.lang.String> getViewHtmlList(@NotNull
                                                                                                   Plan plan,
                                                                                                   @NotNull
                                                                                                   java.lang.Class<T> pluginClass,
                                                                                                   @NotNull
                                                                                                   java.lang.Class<? extends com.atlassian.plugin.ModuleDescriptor<?>>... moduleDescriptorsClasses)
Generate list of html view 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
moduleDescriptorClasses - plugin descriptors
Returns:
HTML fragments for view.

getEditHtmlList

@NotNull
<T extends BuildConfigurationAwarePlugin> java.util.List<java.lang.String> getEditHtmlList(@NotNull
                                                                                                   BuildConfiguration buildConfiguration,
                                                                                                   @NotNull
                                                                                                   Plan plan,
                                                                                                   @NotNull
                                                                                                   java.lang.Class<T> pluginClass,
                                                                                                   @NotNull
                                                                                                   java.lang.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
moduleDescriptorClasses - plugin descriptors
Returns:
HTML fragments for edit


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.