Package com.atlassian.bamboo.task
Interface TaskHelpLink
-
public interface TaskHelpLink
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @Nullable String
getKey()
@Nullable String
getLinkKey()
@Nullable String
getTitleKey()
@org.jetbrains.annotations.Nullable boolean
isUsingPrefix()
Prefix is used if the task is getting the help url/title from help-paths.properties file, in which case we should use the help.url macro.
-
-
-
Method Detail
-
getKey
@Nullable @Nullable String getKey()
- Returns:
- the key to be used by the help.url macro. Should only be used if isUsingPrefix() == true
-
getLinkKey
@Nullable @Nullable String getLinkKey()
- Returns:
- i18n key for the help link, which then needs to be looked up
-
getTitleKey
@Nullable @Nullable String getTitleKey()
- Returns:
- i18n key for the help title
-
isUsingPrefix
@Nullable @org.jetbrains.annotations.Nullable boolean isUsingPrefix()
Prefix is used if the task is getting the help url/title from help-paths.properties file, in which case we should use the help.url macro.- Returns:
- true if we should use the help.url macro, false otherwise
-
-