com.atlassian.bamboo.variable

Interface VariableDefinitionDao

All Superinterfaces:

BambooObjectDao<VariableDefinition>

All Known Implementing Classes:

VariableDefinitionHibernateDao

public interface VariableDefinitionDao
extends BambooObjectDao<VariableDefinition>

Method Summary

Modifier and Type	Method and Description
long	countAll()
int	countVariablesByEnvironmentId(long environmentId) Count variables associated with deployment environment
int	deleteByDeploymentVersion(DeletionSQLAdapter deletionAdapter) Delete VariableDefinitions related to DeploymentVersions.
int	deleteByEnvironment(DeletionSQLAdapter deletionAdapter) Delete VariableDefinitions related to Environments.
int	deleteByPlan(long planId) Delete VariableDefinitions related to a plan.
Collection<? extends VariableDefinition>	findAll() Find all variable definitions
VariableDefinition	findById(long id) Find variable definition of specified id
VariableDefinition	findGlobalVariableByKey(String key) Find global variable by its key
List<VariableDefinition>	findGlobalVariables() Find global variable definitions.
VariableDefinition	findPlanVariableByKey(PlanIdentifier plan, String key) Find plan variable by its key
Iterable<VariableDefinition>	findVariablesByEnvironmentId(long environmentId) Find variables associated with deployment environment
List<VariableDefinition>	findVariablesByPlan(PlanIdentifier plan) Find plan variable definitions for a given plan
Iterable<VariableDefinition>	findVariablesByVersionId(long deploymentVersionId) Find variables associated with deployment version

Methods inherited from interface com.atlassian.bamboo.persistence3.BambooObjectDao

countAll, countWithRestriction, delete, deleteAll, findAll, findById, merge, save, saveAll

Method Detail

findById

@Nullable
VariableDefinition findById(long id)

Find variable definition of specified id

Parameters:

id - id of variable definition

Returns:

variable definition of specified id or null if not found

findGlobalVariables

@NotNull
List<VariableDefinition> findGlobalVariables()

Find global variable definitions.

Returns:

global variable definition collection

findGlobalVariableByKey

@Nullable
VariableDefinition findGlobalVariableByKey(@NotNull
                                                     String key)

Find global variable by its key

Parameters:

key - key which identifies global variable definition

Returns:

variable definition or null if not found

findVariablesByPlan

@NotNull
List<VariableDefinition> findVariablesByPlan(@NotNull
                                                      PlanIdentifier plan)

Find plan variable definitions for a given plan

Parameters:

plan - plan which associated variable definition should be retrieved

Returns:

variable definition matching plan or empty collection if not found

findPlanVariableByKey

@Nullable
VariableDefinition findPlanVariableByKey(@NotNull
                                                   PlanIdentifier plan,
                                                   @NotNull
                                                   String key)

Find plan variable by its key

Parameters:

plan - plan used to filter variables

key - key which identifies plan variable definition

Returns:

variable definition or null if not found

findAll

@NotNull
Collection<? extends VariableDefinition> findAll()

Find all variable definitions

Returns:

Collection of all variable definitions

countVariablesByEnvironmentId

int countVariablesByEnvironmentId(long environmentId)

Count variables associated with deployment environment

Parameters:

environmentId - id of a deployment environment

Returns:

number of variables found

Since:

5.15

findVariablesByEnvironmentId

@NotNull
Iterable<VariableDefinition> findVariablesByEnvironmentId(long environmentId)

Find variables associated with deployment environment

Parameters:

environmentId - id of a deployment environment

Returns:

list of variables found

Since:

5.0

findVariablesByVersionId

@NotNull
Iterable<VariableDefinition> findVariablesByVersionId(long deploymentVersionId)

Find variables associated with deployment version

Parameters:

deploymentVersionId - id of a deployment version

Returns:

list of variables found

Since:

5.0

deleteByEnvironment

int deleteByEnvironment(@NotNull
                        DeletionSQLAdapter deletionAdapter)

Delete VariableDefinitions related to Environments.

Parameters:

deletionAdapter - DeletionSQLAdapter.getInClause()

Returns:

deleteByDeploymentVersion

int deleteByDeploymentVersion(@NotNull
                              DeletionSQLAdapter deletionAdapter)

Delete VariableDefinitions related to DeploymentVersions.

Parameters:

deletionAdapter -

deleteByPlan

int deleteByPlan(long planId)

Delete VariableDefinitions related to a plan.

Parameters:

planId -

Returns:

deleted rows count

Since:

6.8

countAll

long countAll()