com.atlassian.bamboo.task

Interface TaskExecutableType

All Known Implementing Classes:

TaskExecutableTypeImpl

@Internal
public interface TaskExecutableType

Allows for the TaskType to configure an Executable capability

Method Summary

Modifier and Type	Method and Description
String	getExecutableKey() The short "key" of the executable for when the TaskType is addressed through com.atlassian.bamboo.ww2.actions.build.admin.create.UIConfigBean#getBuilderLabels This is usually the component of the TaskType Capability key between CapabilityDefaultsHelper.CAPABILITY_BUILDER_PREFIX and the label.
String	getI18nExecutableNameKey() An i18n key of the name of the TaskType in the Executable list eg "Maven 2" or "Amazon Beanstalk Deployer"
String	getI18nPathHelpKey() An i18n key to show a hint when the user is configuring the Executable path for this TaskType eg "Please enter the M2_HOME value as your path.
boolean	isPrimaryCapabilityProvider()

Method Detail

getExecutableKey

@NotNull
String getExecutableKey()

The short "key" of the executable for when the TaskType is addressed through com.atlassian.bamboo.ww2.actions.build.admin.create.UIConfigBean#getBuilderLabels
This is usually the component of the TaskType Capability key between CapabilityDefaultsHelper.CAPABILITY_BUILDER_PREFIX and the label. For example the key would "myExe" in "system.builder.myExe.My+Label"

Returns:

key

getI18nExecutableNameKey

@Nullable
String getI18nExecutableNameKey()

An i18n key of the name of the TaskType in the Executable list
eg "Maven 2" or "Amazon Beanstalk Deployer"

Returns:

key

getI18nPathHelpKey

@Nullable
String getI18nPathHelpKey()

An i18n key to show a hint when the user is configuring the Executable path for this TaskType
eg "Please enter the M2_HOME value as your path. e.g. C:/dev/tools/maven-2.0.4"

Returns:

key

isPrimaryCapabilityProvider

boolean isPrimaryCapabilityProvider()

Returns:

true of this Task is the primary provider of the Executable capability.