com.atlassian.bamboo.task
Interface TaskModuleDescriptor

All Superinterfaces:
com.atlassian.plugin.ModuleDescriptor<TaskType>, NameProvider, com.atlassian.plugin.Resourced
All Known Implementing Classes:
TaskModuleDescriptorImpl

public interface TaskModuleDescriptor
extends com.atlassian.plugin.ModuleDescriptor<TaskType>, NameProvider

Note that this should not be directly used by plugin developers.

Since:
3.1

Method Summary
 CapabilityDefaultsHelper getCapabilityDefaultsHelper()
          Retrieves the instance responsible for detecting the default Capabilitys of this plugin
 java.util.List<TaskCategory> getCategories()
           
 java.lang.String getIconUrl()
          URL to the icon to be used in the Task browser
 TaskConfigurator getTaskConfigurator()
          Retrieves the plugin class responsible fo handling user configuration of this plugin.
 java.util.List<TaskExecutableType> getTaskExecutables()
           
 
Methods inherited from interface com.atlassian.plugin.ModuleDescriptor
destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion
 
Methods inherited from interface com.atlassian.plugin.Resourced
getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation
 
Methods inherited from interface com.atlassian.bamboo.utils.NameProvider
getName
 

Method Detail

getTaskConfigurator

@Nullable
TaskConfigurator getTaskConfigurator()
Retrieves the plugin class responsible fo handling user configuration of this plugin.

Returns:
TaskConfigurator for this TaskType

getCapabilityDefaultsHelper

@Nullable
CapabilityDefaultsHelper getCapabilityDefaultsHelper()
Retrieves the instance responsible for detecting the default Capabilitys of this plugin

Returns:
CapabilityDefaultsHelper for this TaskType

getCategories

@NotNull
java.util.List<TaskCategory> getCategories()
Returns:
a list of TaskCategorys that this module belongs to

getTaskExecutables

@NotNull
java.util.List<TaskExecutableType> getTaskExecutables()
Returns:
details for TaskType executable

getIconUrl

@Nullable
java.lang.String getIconUrl()
URL to the icon to be used in the Task browser

Returns:
url to the resource named 'icon' with the type 'download'
Since:
3.3


Copyright © 2012 Atlassian. All Rights Reserved.