@PublicApi
public interface VariableDefinitionManager
Modifier and Type | Method and Description |
---|---|
VariableContextBuilder |
createVariableContextBuilder() |
void |
deleteVariableDefinition(VariableDefinition variableDefinition)
Delete variable definition
|
void |
deleteVariablesForPlan(Plan plan)
Removes variable definitions form specified plan
|
VariableDefinition |
findVariableDefinition(long id)
Find variable definition of specified id
|
List<VariableDefinition> |
getDeploymentEnvironmentVariables(long environmentId)
Get list of environment variables associated with a given deployment environment
|
List<VariableDefinition> |
getDeploymentVersionVariables(long deploymentVersionId)
Get list of environment variables associated with a given deployment version
|
List<VariableDefinition> |
getGlobalNotOverriddenEnvironmentVariables(long environmentId) |
List<VariableDefinition> |
getGlobalNotOverriddenVariables(PlanIdentifier plan)
Get list of all global variables that are not overridden by plan variables for a given plan
|
VariableDefinition |
getGlobalVariableByKey(String key)
Retrieves a specific global variable by key.
|
List<VariableDefinition> |
getGlobalVariables()
Get list of all global variables
|
VariableDefinition |
getPlanVariableByKey(PlanIdentifier plan,
String key)
Retrieves a specific variable for the plan with the given key
|
List<VariableDefinition> |
getPlanVariables(PlanIdentifier plan)
Get list of plan variables associated with a given plan
|
Map<String,String> |
getSimpleVariableMapByType(VariableContext variableContext,
VariableType variableType)
Filter variable context by variable type and return as simple key/value map
|
void |
saveVariableDefinition(VariableDefinition variableDefinition)
Save variable definition
|
void |
saveVariableDefinition(VariableDefinition variableDefinition,
String previousValue)
Save variable definition
|
void |
saveVariableDefinitions(List<VariableDefinition> variableDefinitions)
Save all variable definitions on the list
|
@Nullable VariableDefinition findVariableDefinition(long id)
id
- id of variable definitionvoid saveVariableDefinition(@NotNull VariableDefinition variableDefinition)
variableDefinition
- variable definition to be savedvoid saveVariableDefinition(@NotNull VariableDefinition variableDefinition, @Nullable String previousValue)
variableDefinition
- variable definition to be savedpreviousValue
- previous variable valuevoid deleteVariableDefinition(@NotNull VariableDefinition variableDefinition)
variableDefinition
- variable definition to be deleted@NotNull List<VariableDefinition> getGlobalVariables()
@Nullable VariableDefinition getGlobalVariableByKey(String key)
key
- of the variable@Nullable VariableDefinition getPlanVariableByKey(@NotNull PlanIdentifier plan, @NotNull String key)
plan
- variable belongs tokey
- of variable@NotNull List<VariableDefinition> getPlanVariables(@NotNull PlanIdentifier plan)
plan
- Plan whose associated variables should be returned@NotNull List<VariableDefinition> getDeploymentEnvironmentVariables(long environmentId)
environmentId
- id of Deployment environment@NotNull List<VariableDefinition> getDeploymentVersionVariables(long deploymentVersionId)
deploymentVersionId
- id of Deployment environment@NotNull Map<String,String> getSimpleVariableMapByType(@NotNull VariableContext variableContext, @NotNull VariableType variableType)
variableContext
- variableType
- void deleteVariablesForPlan(@NotNull Plan plan)
plan
- @NotNull List<VariableDefinition> getGlobalNotOverriddenVariables(@NotNull PlanIdentifier plan)
plan
- Plan whose associated variables should be used@NotNull List<VariableDefinition> getGlobalNotOverriddenEnvironmentVariables(@NotNull long environmentId)
void saveVariableDefinitions(List<VariableDefinition> variableDefinitions)
@NotNull VariableContextBuilder createVariableContextBuilder()
Copyright © 2016 Atlassian Software Systems Pty Ltd. All rights reserved.