VariableValidationService (Atlassian Bamboo 6.2.2 API)

All Known Implementing Classes:

VariableValidationServiceImpl
```
public interface VariableValidationService
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`validateIdForDeploymentEnvironmentVariable(com.atlassian.struts.ValidationAware validationAware, long variableId, long environmentId)` Validate if id identifies an existing variable associated with Deployment Environment *
`void`	`validateIdForDeploymentEnvironmentVariable(com.opensymphony.xwork.ValidationAware validationAware, long variableId, long environmentId)` Deprecated. since 5.1 use the method with `ValidationAware`
`void`	`validateIdForGlobalVariable(com.atlassian.struts.ValidationAware validationAware, long variableId)` Validate if id identifies global variable
`void`	`validateIdForGlobalVariable(com.opensymphony.xwork.ValidationAware validationAware, long variableId)` Deprecated. since 5.1 use the method with `ValidationAware`
`void`	`validateIdForPlanVariable(com.atlassian.struts.ValidationAware validationAware, long variableId, ImmutablePlan expectedPlan)` Validate if id identifies plan variable of a given plan
`void`	`validateIdForPlanVariable(com.opensymphony.xwork.ValidationAware validationAware, long variableId, ImmutablePlan expectedPlan)` Deprecated. since 5.1 use the method with `ValidationAware`
`void`	`validateKey(com.atlassian.struts.ValidationAware validationAware, String fieldName, String variableKey)` Validate String against Bamboo general rules for variable keys
`void`	`validateKey(com.opensymphony.xwork.ValidationAware validationAware, String fieldName, String variableKey)` Deprecated. since 5.1 use the method with `ValidationAware`
`void`	`validateValueForVariable(com.atlassian.struts.ValidationAware validationAware, String fieldName, String variableValue)` Validate String against Bamboo general rules for variable value
`void`	`validateValueForVariable(com.opensymphony.xwork.ValidationAware validationAware, String fieldName, String variableValue)` Deprecated. since 5.1 use the method with `ValidationAware`

Method Detail

validateIdForGlobalVariable

void validateIdForGlobalVariable(@NotNull
                                 com.atlassian.struts.ValidationAware validationAware,
                                 long variableId)

Validate if id identifies global variable

Parameters:: validationAware - the object to add errors to if any are found; variableId - the actual id to validate

validateIdForPlanVariable

void validateIdForPlanVariable(@NotNull
                               com.atlassian.struts.ValidationAware validationAware,
                               long variableId,
                               @NotNull
                               ImmutablePlan expectedPlan)

Validate if id identifies plan variable of a given plan

Parameters:: validationAware - the object to add errors to if any are found; variableId - the actual id to validate; expectedPlan - the Plan we expect this variable to be associated to

validateIdForDeploymentEnvironmentVariable
```
void validateIdForDeploymentEnvironmentVariable(@NotNull
                                                com.atlassian.struts.ValidationAware validationAware,
                                                long variableId,
                                                long environmentId)
```
Validate if id identifies an existing variable associated with Deployment Environment *

Parameters:

validationAware - the object to add errors to if any are found

variableId - the actual id to validate

environmentId - the id of an com.atlassian.bamboo.deployments.environments.Environment we expect this variable to be associated to

validateKey

void validateKey(@NotNull
                 com.atlassian.struts.ValidationAware validationAware,
                 @NotNull
                 String fieldName,
                 @Nullable
                 String variableKey)

Validate String against Bamboo general rules for variable keys

Parameters:: validationAware - the object to add errors to if any are found; fieldName - the name of the field to add the errors to; variableKey - the actual key to validate

validateValueForVariable

void validateValueForVariable(@NotNull
                              com.atlassian.struts.ValidationAware validationAware,
                              @NotNull
                              String fieldName,
                              @Nullable
                              String variableValue)

Validate String against Bamboo general rules for variable value

Parameters:: validationAware - the object to add errors to if any are found; fieldName - the name of the field to add the errors to; variableValue - the actual value to validate