com.atlassian.bamboo.variable
Interface VariableValidationService

All Known Implementing Classes:

VariableValidationServiceImpl

public interface VariableValidationService

Method Summary

void	validateIdForDeploymentEnvironmentVariable(com.opensymphony.xwork.ValidationAware validationAware, long variableId, long environmentId) Validate if id identifies an existing variable associated with Deployment Environment *
void	validateIdForGlobalVariable(com.opensymphony.xwork.ValidationAware validationAware, long variableId) Validate if id identifies global variable
void	validateIdForPlanVariable(com.opensymphony.xwork.ValidationAware validationAware, long variableId, ImmutablePlan expectedPlan) Validate if id identifies plan variable of a given plan
void	validateKey(com.opensymphony.xwork.ValidationAware validationAware, java.lang.String fieldName, java.lang.String variableKey) Validate String against Bamboo general rules for variable keys
void	validateValueForVariable(com.opensymphony.xwork.ValidationAware validationAware, java.lang.String fieldName, java.lang.String variableValue) Validate String against Bamboo general rules for variable value

Method Detail

validateIdForGlobalVariable

void validateIdForGlobalVariable(@NotNull
                                 com.opensymphony.xwork.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.opensymphony.xwork.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.opensymphony.xwork.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 Environment we expect this variable to be associated to

validateKey

void validateKey(@NotNull
                 com.opensymphony.xwork.ValidationAware validationAware,
                 @NotNull
                 java.lang.String fieldName,
                 @Nullable
                 java.lang.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.opensymphony.xwork.ValidationAware validationAware,
                              @NotNull
                              java.lang.String fieldName,
                              @Nullable
                              java.lang.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