com.atlassian.bamboo.variable

Interface VariableDefinitionFactory

All Known Implementing Classes:

VariableDefinitionFactoryImpl

public interface VariableDefinitionFactory

Method Summary

Modifier and Type	Method and Description
VariableDefinition	createGlobalVariable(@NotNull String key, @NotNull String value) Create global variable definition
VariableDefinition	createPlanVariable(@NotNull Plan plan, @NotNull String key, @NotNull String value) Create plan variable definition
VariableDefinition	createVariableForEnvironment(long environmentId, String variableKey, String variableValue) Create variable for deployment environment
VariableDefinition	createVariableForProject(long projectId, String variableKey, String variableValue) Create variable for a project
VariableDefinition	createVariableForVersion(long deploymentVersionId, String variableKey, String variableValue) Create variable for deployment version

Method Detail

createGlobalVariable

VariableDefinition createGlobalVariable(@NotNull
                                        @NotNull String key,
                                        @NotNull
                                        @NotNull String value)

Create global variable definition

Parameters:

key - variable key

value - variable value

Returns:

VariableDefinition object

createPlanVariable

VariableDefinition createPlanVariable(@NotNull
                                      @NotNull Plan plan,
                                      @NotNull
                                      @NotNull String key,
                                      @NotNull
                                      @NotNull String value)

Create plan variable definition

Parameters:

plan - plan associated with variable

key - variable key

value - variable value

Returns:

VariableDefinition object

createVariableForEnvironment

VariableDefinition createVariableForEnvironment(long environmentId,
                                                String variableKey,
                                                String variableValue)

Create variable for deployment environment

Parameters:

environmentId -

variableKey -

variableValue -

Returns:

createVariableForVersion

VariableDefinition createVariableForVersion(long deploymentVersionId,
                                            String variableKey,
                                            String variableValue)

Create variable for deployment version

Parameters:

deploymentVersionId -

variableKey -

variableValue -

Returns:

createVariableForProject

VariableDefinition createVariableForProject(long projectId,
                                            String variableKey,
                                            String variableValue)

Create variable for a project

Parameters:

projectId -

variableKey -

variableValue -

Returns: