Uses of Class
com.atlassian.bamboo.plan.PlanKey

Packages that use PlanKey

Package	Description
com.atlassian.bamboo
com.atlassian.bamboo.artifact
com.atlassian.bamboo.build
com.atlassian.bamboo.build.artifact
com.atlassian.bamboo.build.creation
com.atlassian.bamboo.build.strategy
com.atlassian.bamboo.builder.resultsfilter
com.atlassian.bamboo.caching
com.atlassian.bamboo.chains
com.atlassian.bamboo.comment
com.atlassian.bamboo.deletion
com.atlassian.bamboo.jira.issuelink
com.atlassian.bamboo.labels
com.atlassian.bamboo.plan
com.atlassian.bamboo.plan.branch
com.atlassian.bamboo.plan.cache
com.atlassian.bamboo.plan.cache.index
com.atlassian.bamboo.plan.job
com.atlassian.bamboo.plan.stage
com.atlassian.bamboo.plan.vcsRevision
com.atlassian.bamboo.repository
com.atlassian.bamboo.resultsummary
com.atlassian.bamboo.resultsummary.search
com.atlassian.bamboo.resultsummary.tests
com.atlassian.bamboo.resultsummary.vcs
com.atlassian.bamboo.security
com.atlassian.bamboo.task
com.atlassian.bamboo.trigger
com.atlassian.bamboo.util
com.atlassian.bamboo.v2.build
com.atlassian.bamboo.v2.build.queue
com.atlassian.bamboo.v2.build.repository
com.atlassian.bamboo.v2.build.requirement
com.atlassian.bamboo.v2.build.trigger

Uses of PlanKey in com.atlassian.bamboo

Methods in com.atlassian.bamboo with parameters of type PlanKey

Modifier and Type	Method and Description
Collection<ErrorDetails>	Bamboo.getErrorMessages(PlanKey planKey) Deprecated. since 5.10

Uses of PlanKey in com.atlassian.bamboo.artifact

Methods in com.atlassian.bamboo.artifact with parameters of type PlanKey

Modifier and Type	Method and Description
List<MutableArtifact>	ArtifactDao.findPlanArtifactsReferencedByVersion(PlanKey planKey) Find all artifacts that belong to a plan are part of a deployment version.
void	ArtifactDao.removeByPlanKey(PlanKey planKey) Remove all artifacts that belong to a plan and are not part of a deployment version.
void	ArtifactDao.updatePlanKey(PlanKey originalPlanKey, PlanKey newPlanKey) Update planKey in Artifact entities when plan key has changed (ie after moving plan)

Uses of PlanKey in com.atlassian.bamboo.build

Methods in com.atlassian.bamboo.build with parameters of type PlanKey

Modifier and Type	Method and Description
void	StopBuildManager.cancelAllBuilds(PlanKey planKey, boolean abandonResult) Will stop all builds running for plan identified by PlanKey
List<LinkedJiraIssue>	JiraIssueResultsManager.findJiraIssuesForPlanKey(PlanKey planKey) Finds a list of jira issues linked to a particular build key
BuildDefinition	BuildDefinitionManager.getBuildDefinition(PlanKey planKey) Returns a stateful version the build definition for the Plan.
Iterable<CurrentlyBuilding>	BuildExecutionManager.getCurrentlyExecuting(PlanKey planKey)
BuildDefinition	BuildDefinitionManager.getUnmergedBuildDefinition(PlanKey planKey) Returns a stateful version the build definition for the Plan.
void	BuildLoggerManager.removeBuildLogger(PlanKey planKey) Removes plan logger for given plan key.
void	BuildNumberGeneratorService.synchroniseJobsBuildNumbers(Set<PlanKey> jobKeys, PlanKey chainKey) Synchronises build number between chain and job

Method parameters in com.atlassian.bamboo.build with type arguments of type PlanKey

Modifier and Type	Method and Description
void	PlanDependencyManager.adjustChildDependencyList(String dependencyType, Plan plan, Set<PlanKey> newChildPlanKeys, boolean overwriteExisting) Update the existing children dependencies of the given plan and dependency Type to match the provided list of new children.
void	PlanDependencyManager.adjustParentDependencyList(String dependencyType, Plan plan, Set<PlanKey> newParentPlanKeys, boolean overwriteExisting) Update the existing parent dependencies of the given plan and dependency Type to match the provided list of new parents.
void	BuildNumberGeneratorService.synchroniseJobsBuildNumbers(Set<PlanKey> jobKeys, PlanKey chainKey) Synchronises build number between chain and job

Uses of PlanKey in com.atlassian.bamboo.build.artifact

Methods in com.atlassian.bamboo.build.artifact with parameters of type PlanKey

Modifier and Type	Method and Description
void	ArtifactManager.removeArtifactsFromStorage(PlanKey planKey) Removes artifact files for all results of a single.
void	ArtifactHandler.removeArtifactsFromStorage(PlanKey planKey, ArtifactHandlerConfigProvider artifactHandlerConfigProvider) Removes artifact files for all results of a single.

Uses of PlanKey in com.atlassian.bamboo.build.creation

Methods in com.atlassian.bamboo.build.creation that return types with arguments of type PlanKey

Modifier and Type	Method and Description
List<PlanKey>	JobCreationService.createJobAndBranches(BuildConfiguration buildConfiguration, ActionParametersMap actionParametersMap, PlanCreationService.EnablePlan ifPlanEnabled)

Methods in com.atlassian.bamboo.build.creation with parameters of type PlanKey

Modifier and Type	Method and Description
void	PlanCreationService.triggerCreationCompleteEvents(PlanKey planKey) Trigger the appropriate events after the plan has been saved successfully Calling this method is responsibility of class using this service.

Uses of PlanKey in com.atlassian.bamboo.build.strategy

Methods in com.atlassian.bamboo.build.strategy with parameters of type PlanKey

Modifier and Type	Method and Description
BuildStrategy	BuildStrategyConfigurationService.createBuildStrategy(PlanKey planKey, String userDescription, Set<Long> triggeringRepositories, org.apache.commons.configuration.HierarchicalConfiguration configuration) Deprecated. Creates a BuildStrategy and saves it in Chain configuration.
void	BuildStrategyConfigurationService.deleteBuildStrategy(PlanKey planKey, long buildStrategyId) Deprecated. Delete a given BuildStrategy from Chain configuration.
boolean	PlanDeletionAwareBuildStrategy.isAffectedByPlanDeletion(PlanKey deletedPlanKey) Deprecated. Check if strategy will be affected when Plan is deleted.
boolean	PlanKeyUpdateAwareBuildStrategy.isAffectedByPlanKeyUpdate(PlanKey originalPlanKey) Deprecated. Check if strategy will be affected when Plan's key will change
void	PlanKeyUpdateAwareBuildStrategy.updatePlanKey(PlanKey originalPlanKey, PlanKey newPlanKey) Deprecated. Perform actual update of internal strategy state

Uses of PlanKey in com.atlassian.bamboo.builder.resultsfilter

Methods in com.atlassian.bamboo.builder.resultsfilter with parameters of type PlanKey

Modifier and Type	Method and Description
int	BuildResultsFilter.getFromBuildNumber(PlanKey planKey) The build number (inclusive) that extrenal callers can use to filter for a given plan.

Uses of PlanKey in com.atlassian.bamboo.caching

Methods in com.atlassian.bamboo.caching with parameters of type PlanKey

Modifier and Type	Method and Description
ImmutableChain	DashboardCachingManager.getPlan(PlanKey planKey) Returns the cached plan for a given planKey
void	DashboardCachingManager.removePlanFromCache(PlanKey planKey) Removes the plan from the cache
void	DashboardCachingManager.updatePlanCache(PlanKey planKey) Refetches the passed plan key from the database

Method parameters in com.atlassian.bamboo.caching with type arguments of type PlanKey

Modifier and Type	Method and Description
void	DashboardCachingManager.removePlansFromCache(Iterable<PlanKey> planKeys)
void	DashboardCachingManager.updatePlanCache(Collection<PlanKey> planKeys) Refetches the passed plan keys from the database

Uses of PlanKey in com.atlassian.bamboo.chains

Methods in com.atlassian.bamboo.chains that return types with arguments of type PlanKey

Modifier and Type	Method and Description
com.google.common.collect.Multimap<PlanKey,Long>	ChainStageDao.getChainStagesMarkedForDeletion()

Methods in com.atlassian.bamboo.chains with parameters of type PlanKey

Modifier and Type	Method and Description
List<ChainExecution>	ChainExecutionManager.getExecutingChains(PlanKey planKey) Get the Collection of the state of the ChainExecution or empty collection when no chain is executing
boolean	ChainExecutionManager.isActive(PlanKey planKey) Checks if the Chain is "active" ie being queued, or building
boolean	ChainExecutionManager.isExecuting(PlanKey planKey) Checks if the Chain is building
int	ChainExecutionManager.numberOfChainsExecuting(PlanKey planKey) Determines the number of ChainExecutions are active for the given PlanKey
void	ChainExecutionManager.stop(PlanKey planKey) Stops all executing instances of the Chain represented by PlanKey

Uses of PlanKey in com.atlassian.bamboo.comment

Methods in com.atlassian.bamboo.comment with parameters of type PlanKey

Modifier and Type	Method and Description
List<Comment>	CommentManager.getCommentsForBuildResults(PlanKey planKey) Get all comments associated with Plan's build results
List<Comment>	CommentDao.getCommentsForBuildResults(PlanKey planKey)

Uses of PlanKey in com.atlassian.bamboo.deletion

Methods in com.atlassian.bamboo.deletion that return types with arguments of type PlanKey

Modifier and Type	Method and Description
Set<PlanKey>	DeletionService.deletePlans(Iterable<String> planKeys)
Set<PlanKey>	DeletionService.deleteProjects(Iterable<String> projectKeys)

Uses of PlanKey in com.atlassian.bamboo.jira.issuelink

Methods in com.atlassian.bamboo.jira.issuelink with parameters of type PlanKey

Modifier and Type	Method and Description
void	JiraBranchLinkingService.linkBranchToIssueIfRequiredAsync(PlanKey planKey, String username) Looks for an issue key in the branch name.

Uses of PlanKey in com.atlassian.bamboo.labels

Methods in com.atlassian.bamboo.labels with parameters of type PlanKey

Modifier and Type	Method and Description
int	LabelManager.addLabel(String labelName, PlanKey planKey, com.atlassian.user.User user) Creates a normal label for a plan
boolean	LabelManager.addLabels(List<String> labelNames, PlanKey planKey, com.atlassian.user.User user) Creates multiple normal labels for a plan
int	LabelManager.removeLabel(String labelName, PlanKey planKey, com.atlassian.user.User user) Remove the standard label for a plan (not all the labels for that plan)

Uses of PlanKey in com.atlassian.bamboo.plan

Fields in com.atlassian.bamboo.plan with type parameters of type PlanKey

Modifier and Type	Field and Description
static com.google.common.base.Function<PlanKey,PlanKey>	PlanKeys.CHAIN_KEY_FROM_JOB_KEY
static com.google.common.base.Function<PlanKey,PlanKey>	PlanKeys.CHAIN_KEY_FROM_JOB_KEY
static com.google.common.base.Function<PlanKeyProvider,PlanKey>	PlanKeyProvider.getPlanKey
static com.google.common.base.Function<PlanIdentifier,PlanKey>	PlanIdentifier.getPlanKeyFunction Function to extract PlanKey from PlanIdentifier
static com.google.common.base.Function<PlanKey,String>	PlanKeys.PARTIAL_JOB_KEY_FROM_JOB_KEY
static Comparator<PlanKey>	PlanKeys.PLAN_KEY_COMPARATOR
static com.google.common.base.Function<PlanKey,String>	PlanKeys.planKeyToKey
static com.google.common.base.Function<PlanKey,String>	PlanKeys.SHORT_KEY_FROM_PLAN_KEY

Methods in com.atlassian.bamboo.plan that return PlanKey

Modifier and Type	Method and Description
static PlanKey	PlanKeys.asDeletedPlanKey(PlanKey planKey)
static PlanKey	PlanKeys.asNonDeletedPlanKey(PlanKey planKey)
static PlanKey	PlanKeys.getChainKeyFromJobKey(PlanKey jobKey) Extracts a Chain key from a jobKey and creates new PlanKey For example, BAM-REL-UNIT becomes BAM-REL
static PlanKey	PlanKeys.getChainKeyIfJobKey(PlanKey jobKey) Extracts a Chain key from a jobKey and creates new PlanKey For example, BAM-REL-UNIT becomes BAM-REL Returns a Chain key if the passed in key is a Job key, otherwise a null is returned
static PlanKey	PlanKeys.getJobKey(PlanKey chainPlanKey, String jobKey) Joins the a Chain key and a jobKey part to create a Job PlanKey For example, BAM-REL and UNIT becomes BAM-REL-UNIT
PlanKey	PlanAwareContext.getPlanKey()
PlanKey	PlanResultKey.getPlanKey() Returns the key component of this PlanResultKey
PlanKey	PlanIdentifier.getPlanKey() Get the PlanKey identifier for this Plan
PlanKey	PlanKeyProvider.getPlanKey()
PlanKey	PlanPermissionSkeleton.getPlanKey() Deprecated.
static PlanKey	PlanKeys.getPlanKey(String planKey) Creates a PlanKey from its string form 'BAM-BOO' or from the result key form 'BAM-BOO-123'
static PlanKey	PlanKeys.getPlanKey(String projectKey, String buildKey) Creates a PlanKey from project key and build key
static PlanKey	PlanKeys.getPlanKey(String projectKey, String chainKey, String buildKey) Creates a PlanKey from project key, parent chain key and build key
static PlanKey	PlanKeys.updatePlanKeyInBranchKey(PlanKey branchKey, PlanKey originalPlanKey, PlanKey newPlanKey) Update plan key part in branch key

Methods in com.atlassian.bamboo.plan that return types with arguments of type PlanKey

Modifier and Type	Method and Description
<T extends Plan> List<PlanKey>	PlanManager.getAllPlanKeys(Class<T> planType) Returns keys of all Plan's filtered by Class.
Set<PlanKey>	PlanParticleManager.getConsumersPlanKeys(Iterable<? extends PlanParticle> planParticles) Return collection of Plan keys registered as planParticle consumers
Set<PlanKey>	PlanParticleManager.getConsumersPlanKeys(PlanKey planKey) Return collection of Plan keys registered as consumers of particles produced by plan identified with planKey
List<PlanKey>	PlanDao.getJobKeys(PlanKey chainKey) Return all plan keys of Jobs that belong to a Chain
<T extends Plan> List<PlanKey>	PlanDao.getPlanKeys(Class<T> planType) Returns all plan keys of a particular type
Set<PlanKey>	PlanParticleManager.getProducersPlanKeys(Iterable<? extends PlanParticle> planParticles) Return collection of Plan keys registered as planParticle producers
Set<PlanKey>	PlanParticleManager.getProducersPlanKeys(PlanKey planKey) Return collection of Plan keys registered as consumers of particles produced by plan identified with planKey
Map<PlanKey,PlanKey>	MovePlansException.getSuccessfulPlanKeyChanges()
Map<PlanKey,PlanKey>	MovePlansException.getSuccessfulPlanKeyChanges()
Map<PlanKey,PlanKey>	MovePlanService.movePlansToProject(Collection<TopLevelPlan> plans, Project project, Map<String,String> planKeyMappings, Map<String,String> planNameMappings) Moves a list of plans to a new project.
Map<PlanKey,PlanKey>	MovePlanService.movePlansToProject(Collection<TopLevelPlan> plans, Project project, Map<String,String> planKeyMappings, Map<String,String> planNameMappings) Moves a list of plans to a new project.
static com.google.common.base.Function<PlanIdentifier,PlanKey>	PlanKeys.planKeyFromPlan()
static com.google.common.base.Function<PlanResultKey,PlanKey>	PlanKeys.planKeyFromPlanResultKey()
static com.google.common.base.Function<String,PlanKey>	PlanKeys.planKeyFromString()
static com.google.common.base.Function<PlanKey,String>	PlanKeys.planKeyToString()

Methods in com.atlassian.bamboo.plan with parameters of type PlanKey

Modifier and Type	Method and Description
void	PlanParticleManager.adjustPlanParticles(PlanKey planKey, Collection<? extends PlanParticle> consumedParticles, Collection<? extends PlanParticle> producedParticles) Adjust list of plan's consumed and produced particles.
static PlanKey	PlanKeys.asDeletedPlanKey(PlanKey planKey)
static PlanKey	PlanKeys.asNonDeletedPlanKey(PlanKey planKey)
int	PlanKey.compareTo(PlanKey planKey)
static com.atlassian.fugue.Option<Long>	PlanKeys.getBranchNumberSuffix(PlanKey chainKey, PlanKey branchKey) Extract numerical branch suffix
static PlanKey	PlanKeys.getChainKeyFromJobKey(PlanKey jobKey) Extracts a Chain key from a jobKey and creates new PlanKey For example, BAM-REL-UNIT becomes BAM-REL
static PlanKey	PlanKeys.getChainKeyIfJobKey(PlanKey jobKey) Extracts a Chain key from a jobKey and creates new PlanKey For example, BAM-REL-UNIT becomes BAM-REL Returns a Chain key if the passed in key is a Job key, otherwise a null is returned
Set<PlanKey>	PlanParticleManager.getConsumersPlanKeys(PlanKey planKey) Return collection of Plan keys registered as consumers of particles produced by plan identified with planKey
List<CurrentlyBuilding>	PlanExecutionManager.getCurrentlyBuildingForPlan(PlanKey planKey) Returns all for specified PlanKey In case plan is a Chain instance, all currently running jobs will be returned
Collection<? extends ExecutionStatus>	ExecutionStatusProvider.getExecutionStatus(PlanKey planKey) Returns a collection of current ExecutionStatuss for PlanKey
static PlanKey	PlanKeys.getJobKey(PlanKey chainPlanKey, String jobKey) Joins the a Chain key and a jobKey part to create a Job PlanKey For example, BAM-REL and UNIT becomes BAM-REL-UNIT
List<PlanKey>	PlanDao.getJobKeys(PlanKey chainKey) Return all plan keys of Jobs that belong to a Chain
static String	PlanKeys.getPartialJobKey(PlanKey jobKey) Return a partial job key from a full job key, e.g.
ImmutableChain	PlanService.getPlan(PlanKey planKey) Get an individual stage from a plan
Plan	PlanManager.getPlanByKey(PlanKey planKey) Returns a Plan by its PlanKey
<T extends Plan> T	PlanManager.getPlanByKey(PlanKey planKey, Class<T> planType) Returns a Plan by its PlanKey and Class
<T extends Plan> T	PlanDao.getPlanByKey(PlanKey planKey, Class<T> aClass) Return a Plan that matches the given key
<T extends Plan> T	PlanManager.getPlanByKeyIfOfType(PlanKey planKey, Class<T> planType) Returns a Plan by its planKey and if it's of the type Class.
<T extends Plan> T	PlanManager.getPlanByPartialKeyAndName(PlanKey partialPlanKey, String planName, Class<T> planType) Deprecated. since 4.2
<T extends Plan> T	PlanDao.getPlanByPartialKeyAndName(PlanKey partialPlanKey, String planName, Class<T> planType) Returns a Plan that matches the start of the given PlanKey and name
Class<? extends Plan>	PlanManager.getPlanClass(PlanKey planKey)
Class<? extends Plan>	PlanDao.getPlanClass(PlanKey planKey)
static String	PlanKeys.getPlanKeyPart(PlanKey planKey) Returns plan key part for given PlanKey
static PlanResultKey	PlanKeys.getPlanResultKey(PlanKey planKey, int buildNumber) Creates a PlanResultKey from the given PlanKey and buildNumber
Set<PlanKey>	PlanParticleManager.getProducersPlanKeys(PlanKey planKey) Return collection of Plan keys registered as consumers of particles produced by plan identified with planKey
static String	PlanKeys.getProjectKeyPart(PlanKey planKey) Returns project key part for given PlanKey
static String	PlanKeys.getShortKeyFromPlanKey(PlanKey planKey) Return a last part of the plan key, e.g PROJ-CHAIN would reduce CHAIN and PROJ-CHAIN-HOB would return JOB
boolean	PlanExecutionManager.isBusy(PlanKey planKey) Tests if the Plan represented by PlanKey is busy starting
static boolean	PlanKeys.isChainKey(PlanKey planKey) Checks if PlanKey represents a Chain
static boolean	PlanKeys.isJobKey(PlanKey planKey) Checks if PlanKey represents a Job
boolean	PlanManager.isPlanKeyConflicting(PlanKey planKey) Verifies whether a Plan key is unique within whole Bamboo installation
boolean	PlanDao.isPlanKeyConflicting(PlanKey planKey) Verifies whether a Plan key is unique within whole Bamboo installation
void	PlanDao.markPlanForDeletion(PlanKey planKey) Efficiently marks a plan to be deleted
void	PlanManager.markPlansForDeletion(PlanKey planKey) Efficiently marks a plan to be deleted
int	ExecutionStatusProvider.numberOfExecutions(PlanKey planKey) Returns the number of current ExecutionStatuss available for PlanKey
boolean	ExecutableAgentsHelper.planHasExecutableAgents(PlanKey planKey, boolean includeDisabled) Checks if a Buildable can be built on any defined agent.
void	PlanParticleManager.removePlanParticles(PlanKey planKey) Removes all plan particles for a given plan.
void	PlanManager.removeStages(PlanKey key, Collection<Long> stageIds) Remove the tages from the plan specified.
void	PlanAwareContext.setPlanKey(PlanKey planKey)
void	Plan.setPlanKey(PlanKey planKey)
void	PlanPermissionSkeleton.setPlanKey(PlanKey fullKey) Deprecated.
void	PlanManager.setPlanSuspendedState(PlanKey planKey, boolean newState)
void	PlanExecutionManager.stopPlan(PlanKey planKey, boolean abandonResult, String userName)
void	PlanExecutionManager.stopRequest(PlanKey planKey) Stops a build requests for the given PlanKey
static PlanKey	PlanKeys.updatePlanKeyInBranchKey(PlanKey branchKey, PlanKey originalPlanKey, PlanKey newPlanKey) Update plan key part in branch key

Constructor parameters in com.atlassian.bamboo.plan with type arguments of type PlanKey

Constructor and Description
MovePlansException(String s, Map<PlanKey,PlanKey> successfulPlanKeyChanges)
MovePlansException(String s, Map<PlanKey,PlanKey> successfulPlanKeyChanges)
MovePlansException(String s, Throwable throwable, Map<PlanKey,PlanKey> successfulPlanKeyChanges)
MovePlansException(String s, Throwable throwable, Map<PlanKey,PlanKey> successfulPlanKeyChanges)

Uses of PlanKey in com.atlassian.bamboo.plan.branch

Methods in com.atlassian.bamboo.plan.branch that return PlanKey

Modifier and Type	Method and Description
PlanKey	BranchDetectionService.createChainBranch(ImmutableChain chain, String branchName, VcsBranch vcsBranch, BuildConfiguration buildConfiguration, PlanCreationService.EnablePlan enablePlan, boolean enableExpiry) Given a branch name and (optionally) vcs branch name, create Plan Branches with overriding repository definitions.
PlanKey	BranchDetectionService.createChainBranch(ImmutableChain chain, String branchName, VcsBranch vcsBranch, PlanCreationService.EnablePlan enablePlan, boolean enableExpiry) Deprecated. in 5.6 use BranchDetectionService.createChainBranch(ImmutableChain, String, VcsBranch, BuildConfiguration, PlanCreationService.EnablePlan, boolean)
PlanKey	BranchIntegrationConfiguration.getBranchToMergeWith(PlanKey featureBranch) Returns the PlanKey of the relevant vcs branch we want to merge with.
PlanKey	BranchIntegrationConfiguration.getIntegrationPlanBranchKey()
PlanKey	BranchIntegrationConfiguration.getMergeResultDestinationBranch(PlanKey featureBranch) Returns the PlanKey of the relevant VCS branch we want to perform the merge on.

Methods in com.atlassian.bamboo.plan.branch that return types with arguments of type PlanKey

Modifier and Type	Method and Description
Collection<PlanKey>	BranchDetectionService.createPlanBranches(ImmutableChain chain, Collection<VcsBranch> branches, ErrorCollection errorCollection) Given a list of branch names, create Plan Branches for these, with overriding repository definitions.
Collection<PlanKey>	BranchDetectionService.createPlanBranches(ImmutableChain chain, Collection<VcsBranch> branches, ErrorCollection errorCollection, PlanCreationService.EnablePlan enablePlan) Given a list of branch names, create Plan Branches for these, with overriding repository definitions.

Methods in com.atlassian.bamboo.plan.branch with parameters of type PlanKey

Modifier and Type	Method and Description
PlanKey	BranchIntegrationConfiguration.getBranchToMergeWith(PlanKey featureBranch) Returns the PlanKey of the relevant vcs branch we want to merge with.
PlanKey	BranchIntegrationConfiguration.getMergeResultDestinationBranch(PlanKey featureBranch) Returns the PlanKey of the relevant VCS branch we want to perform the merge on.

Uses of PlanKey in com.atlassian.bamboo.plan.cache

Methods in com.atlassian.bamboo.plan.cache that return types with arguments of type PlanKey

Modifier and Type	Method and Description
Iterable<PlanKey>	ImmutablePlanCacheService.getChainsToInvalidate(ImmutablePlanCacheService.CacheInvalidator invalidator) Internal.
Iterable<PlanKey>	ImmutablePlanCacheService.CacheInvalidator.getChainsToInvalidate(ImmutablePlanCacheService immutablePlanCacheService, com.google.common.cache.Cache<PlanKey,ImmutableChain> planKeyChainMap) This gets passed some cache internals for invalidation

Methods in com.atlassian.bamboo.plan.cache with parameters of type PlanKey

Modifier and Type	Method and Description
void	ImmutablePlanCacheService.cascadeInvalidate(PlanKey planKey) Removes the cached reference for the passed plan and its children.
int[]	ImmutablePlanCacheService.getBuildNumberOverrides(PlanKey planKey) Deprecated. since 4.4
ImmutableChain	ImmutablePlanCacheService.getImmutablePlanByKey(PlanKey planKey) Returns a plan if one exists with the key.
ImmutableResultsSummary	ImmutablePlanManager.getLatestResultForPlan(PlanKey planKey)
ReentrantReadWriteLock	ImmutablePlanCacheService.getLock(PlanKey planKey) Makes plan inaccessible
ImmutableJob	CachedPlanManager.getMasterOfJob(PlanKey masterChainKey, PlanKey jobKey)
ImmutableChain	CachedPlanManager.getMasterPlan(PlanKey branchKey) Returns master branch for a given branchKey.
ImmutablePlan	CachedPlanManager.getPlanByKey(PlanKey planKey) Returns a ImmutablePlan by its planKey
ImmutableChain	ImmutablePlanManager.getPlanByKey(PlanKey planKey)
<T extends ImmutablePlan> T	CachedPlanManager.getPlanByKey(PlanKey planKey, Class<T> planType) Returns a ImmutablePlan by its planKey and Class
<T extends ImmutablePlan> T	CachedPlanManager.getPlanByKeyIfOfType(PlanKey planKey, Class<T> planType) Returns a Plan by its planKey and if it's of the type Class.
PlanIdentifier	ImmutablePlanCacheService.getPlanIdentifierForPermissionCheckingByKey(PlanKey planKey) Deprecated. since 5.4 use CachedPlanManager.getPlanByKey(com.atlassian.bamboo.plan.PlanKey)
void	ImmutablePlanCacheService.invalidate(PlanKey planKey) Removes the cached Plan.
boolean	CachedPlanManager.isBranchOf(PlanKey chainKey, PlanKey branchKey) Test if plan identified by branchKey is a branch of plan identified by chainKey.
void	ImmutablePlanCacheService.reset(PlanKey planKey) Removes the cached Plan and its metadata.
void	ImmutablePlanCacheService.setBuildNumberOverrides(PlanKey planKey, int firstBuildNumber, int lastBuildNumber, int nextBuildNumber) Deprecated. since 4.4

Method parameters in com.atlassian.bamboo.plan.cache with type arguments of type PlanKey

Modifier and Type	Method and Description
Iterable<PlanKey>	ImmutablePlanCacheService.CacheInvalidator.getChainsToInvalidate(ImmutablePlanCacheService immutablePlanCacheService, com.google.common.cache.Cache<PlanKey,ImmutableChain> planKeyChainMap) This gets passed some cache internals for invalidation

Uses of PlanKey in com.atlassian.bamboo.plan.cache.index

Methods in com.atlassian.bamboo.plan.cache.index that return PlanKey

Modifier and Type	Method and Description
PlanKey	PlanIdCacheIndex.getChain(long chainId)
PlanKey	PlanIdCacheIndex.getChainOfJob(long jobId)

Methods in com.atlassian.bamboo.plan.cache.index that return types with arguments of type PlanKey

Modifier and Type	Method and Description
Set<PlanKey>	PlanIdCacheIndex.getAllChainKeys()
Collection<PlanKey>	PlanBranchCacheIndex.getBranchKeys(PlanKey planKey)
Collection<PlanKey>	PlanRepositoryIndex.getPlans(PlanRepositoryIndex.Query query)

Methods in com.atlassian.bamboo.plan.cache.index with parameters of type PlanKey

Modifier and Type	Method and Description
void	PlanCacheIndexer.deindex(PlanKey planKey)
Collection<PlanKey>	PlanBranchCacheIndex.getBranchKeys(PlanKey planKey)

Uses of PlanKey in com.atlassian.bamboo.plan.job

Methods in com.atlassian.bamboo.plan.job with parameters of type PlanKey

Modifier and Type	Method and Description
ImmutableJob	JobService.addJob(PlanKey chainKey, long stageId, String jobKey, String name, String description, boolean suspended) Add a job to an existing stage in the plan
ImmutableJob	JobService.cloneJob(String sourceJobKey, PlanKey chainKey, long stageId, String newJobKey, String name, String description, boolean suspended) Copy the given job and give the copy the key, name, description and suspended state provided.
void	JobService.deleteJob(PlanKey jobKey, BambooClosures.Throwing1<ImmutableJob,WebValidationException>... runBefore) Remove a job.
ImmutableJob	JobService.getJob(PlanKey jobKey) Get an individual job
List<ImmutableJob>	JobService.getJobsForPlan(PlanKey planKey) Get all jobs in a plan, ordered alphabetically
List<ImmutableJob>	JobService.getJobsForStage(PlanKey planKey, long stageId) Get all jobs in a particular stage, ordered alphabetically
ImmutableJob	JobService.updateJob(PlanKey jobKey, String name, String description, boolean suspended, long stageId, BambooClosures.Throwing1<ImmutableJob,WebValidationException>... runBefore) Update the details of a job
ErrorCollection	JobService.validateJobForAdd(PlanKey chainKey, long stageId, String jobKey, String name, String description, boolean suspended) Validates the parameters for adding a job.
ErrorCollection	JobService.validateJobForClone(String sourceJobKey, PlanKey chainKey, long stageId, String newJobKey, String name, String description, Boolean suspended) Validates the parameters for cloning a job.
ErrorCollection	JobService.validateJobForUpdate(PlanKey jobKey, String name, String description, boolean suspended, long stageId) Validate editing of a job

Uses of PlanKey in com.atlassian.bamboo.plan.stage

Methods in com.atlassian.bamboo.plan.stage with parameters of type PlanKey

Modifier and Type	Method and Description
ImmutableChainStage	StageService.addStage(PlanKey planKey, String name, String description, boolean isManual) Adds a new stage to the specified plan.
void	StageService.deleteStage(PlanKey planKey, long stageId, BambooClosures.Throwing1<ImmutableChainStage,WebValidationException>... runBefore) Deletes the given stage and any jobs under the stage.
ImmutableChainStage	StageService.getStage(PlanKey planKey, long stageId) Get an individual stage from a plan
List<ImmutableChainStage>	StageService.getStagesForPlan(PlanKey planKey) Get all stages in a plan, in order
ImmutableChainStage	StageService.updateStage(PlanKey planKey, long stageId, String name, String description, boolean manual, Integer index, BambooClosures.Throwing1<ImmutableChainStage,WebValidationException>... runBefore) Update the details of a stage.
ErrorCollection	StageService.validateStageForAdd(PlanKey planKey, String name, String description, boolean isManual) Validates a new stage for the specified plan.
ErrorCollection	StageService.validateStageForUpdate(PlanKey planKey, long stageId, String name, String description, boolean manual) Validates editing of a stage.

Uses of PlanKey in com.atlassian.bamboo.plan.vcsRevision

Methods in com.atlassian.bamboo.plan.vcsRevision with parameters of type PlanKey

Modifier and Type	Method and Description
void	PlanVcsRevisionHistoryService.cleanupUnusedEntriesForPlan(PlanKey planKey) Removes history entries that are not used in change detection process.
void	PlanVcsRevisionHistoryService.clearRevisionHistoryForPlan(PlanKey planKey) Removes all history entries for the plan.
PlanVcsRevisionDataSet	PlanVcsRevisionHistoryService.getLastVcsRevisionKeys(PlanKey planKey) Return the mapping between repository ids and strings representing the vcs revisions which were result of last performed change detection.
void	PlanVcsRevisionHistoryService.markChangeDetectionCompleted(PlanKey planKey, int buildNumber, PlanVcsRevisionData revisionData, long repositoryId) Saves the information on change detection result in the plan's vcs revision history.
void	PlanVcsRevisionHistoryService.moveRevisionHistoryForPlan(PlanKey originalPlanKey, PlanKey planKey) Moves history entries that are related to a moved plan.

Uses of PlanKey in com.atlassian.bamboo.repository

Methods in com.atlassian.bamboo.repository with parameters of type PlanKey

Modifier and Type	Method and Description
BuildRepositoryChanges	OnceOffCapableRepository.collectChangesForRevision(PlanKey planKey, String targetRevision) Collects the changes for the targetRevision.
void	RepositoryConfigurationService.moveRepository(PlanKey planKey, long repositoryId, long beforePosition, long afterPosition) Changes position of repository in the repository list.

Uses of PlanKey in com.atlassian.bamboo.resultsummary

Fields in com.atlassian.bamboo.resultsummary declared as PlanKey

Modifier and Type	Field and Description
protected PlanKey	MutableExpiryCriteria.planKey

Methods in com.atlassian.bamboo.resultsummary that return PlanKey

Modifier and Type	Method and Description
PlanKey	MutableExpiryCriteria.getPlanKey()
PlanKey	ImmutableResultsSummary.getPlanKey() Full key of the plan.
PlanKey	ExpiryCriteria.getPlanKey() A plan key by which the result summaries should be filtered.

Methods in com.atlassian.bamboo.resultsummary that return types with arguments of type PlanKey

Modifier and Type	Method and Description
Iterable<PlanKey>	BuildResultsSummaryDao.findPlanKeysFromAllOrphanedResultSummaries() Scans database for all the ResultsSummary objects in the database that do not have a matching Plan
List<PlanKey>	ResultsSummaryManager.getPlanKeysSortedByNumberOfFinalizedResultSummaries()
List<PlanKey>	BuildResultsSummaryDao.getPlanKeysSortedByNumberOfFinalizedResultSummaries()

Methods in com.atlassian.bamboo.resultsummary with parameters of type PlanKey

Modifier and Type	Method and Description
int	ResultsSummaryManager.countResultsWithState(PlanKey planKey, int lowerBuildNumber, int upperBuildNumber, BuildState buildState) Counts results with a given state in a given build number range for plan.
int	BuildResultsSummaryDao.countResultsWithState(PlanKey planKey, int lowerBuildNumber, int upperBuildNumber, BuildState buildState) Counts results with a given state in a given build number range for plan.
List<Integer>	ResultsSummaryManager.findAllBuildResultsNumbers(PlanKey planKey)
List<Integer>	BuildResultsSummaryDao.findAllBuildResultsNumbers(PlanKey planKey)
List<LinkedJiraIssue>	ResultsSummaryManager.findJiraIssuesForPlanKey(PlanKey planKey) Retrieves a list of LinkedJiraIssue linked to the given plan key
<T extends ResultsSummary> T	ResultsSummaryManager.findLastResultSummaryWithState(PlanKey planKey, BuildState buildState, Class<T> aClass)
<T extends ResultsSummary> T	BuildResultsSummaryDao.findLastResultSummaryWithState(PlanKey planKey, BuildState buildState, Class<T> aClass)
<T extends ResultsSummary> Collection<T>	ResultsSummaryManager.getAllActiveResultSummariesForPlan(PlanKey planKey, Class<T> aClass) Returns all the ResultsSummary in a LifeCycleState.IN_PROGRESS state
<T extends ResultsSummary> Collection<T>	BuildResultsSummaryDao.getAllActiveResultSummariesForPlan(PlanKey planKey, Class<T> aClass) Returns all the ResultsSummary in a LifeCycleState.PENDING, LifeCycleState.QUEUED, LifeCycleState.IN_PROGRESS state with the given Class See also LifeCycleState.isActive(LifeCycleState) and ImmutableResultsSummary.isActive()
<T extends ResultsSummary> List<T>	ResultsSummaryManager.getFinalizedResultSummariesForPlan(PlanKey planKey, Class<T> aClass, int firstResult, int maxResults) Returns all the ResultsSummary in a LifeCycleState.FINISHED or LifeCycleState.NOT_BUILT state with the given Class.
<T extends ResultsSummary> List<T>	BuildResultsSummaryDao.getFinalizedResultSummariesForPlan(PlanKey planKey, Class<T> aClass, int firstResult, int maxResults) Returns all the ResultsSummary in a LifeCycleState.FINISHED or LifeCycleState.NOT_BUILT state with the given Class.
BuildResultsSummary	BuildResultsSummaryDao.getFirstBuildSummary(PlanKey planKey) Returns the first available BuildResultsSummary for the given PlanKey
List<LinkedJiraIssue>	BuildResultsSummaryDao.getJiraIssuesForPlanKey(PlanKey planKey) Retrieves a list of LinkedJiraIssue that are linked to the given build.
ResultsSummary	ResultsSummaryManager.getLastSuccessfulResultSummary(PlanKey planKey) Get the last successful ResultsSummary for planKey
Collection<LinkedJiraIssue>	LinkedJiraIssueDao.getLinkedJiraIssuesForBuildNumberRange(PlanKey planKey, int firstBuildNumber, int currentBuildNumber) Find and retrieve all jira issues related to build results from specified range.
int	ResultsSummaryManager.getNumberOfConcurrentlyRunningBuilds(PlanKey planKey) Gets the number of concurrently running builds
int	BuildResultsSummaryDao.getNumberOfConcurrentlyRunningBuilds(PlanKey planKey) Get the number of concurrently running builds for planKey
int	ResultsSummaryManager.markResultSummariesForDeletion(PlanKey planKey) Mass update of all ResultsSummary records in the database related to a Plan identified by planKey.
int	BuildResultsSummaryDao.markResultSummariesForDeletion(PlanKey planKey) Mass update of all ResultsSummary records in the database related to a Plan identified by planKey.
void	ResultsSummaryManager.moveResultSummaries(PlanKey oldPlanKey, PlanKey newPlanKey) Deprecated. since 3.2, use ResultsSummaryManager.moveResultSummaries(Plan, PlanKey, PlanKey)
void	ResultsSummaryManager.moveResultSummaries(Plan newParentPlan, PlanKey oldPlanKey, PlanKey newPlanKey) Reassigns plan key ResultsSummaries associated with selected plan key.
int	BuildResultsSummaryDao.removeResultsSummariesForPlan(PlanKey planKey) Remove all resultSummary objects for the given plan.
ResultsSummaryCriteriaBuilder	ResultsSummaryCriteriaBuilder.setPlanKey(PlanKey planKey)

Constructors in com.atlassian.bamboo.resultsummary with parameters of type PlanKey

Constructor and Description
MutableExpiryCriteria(PlanKey planKey)

Uses of PlanKey in com.atlassian.bamboo.resultsummary.search

Methods in com.atlassian.bamboo.resultsummary.search with parameters of type PlanKey

Modifier and Type	Method and Description
org.apache.lucene.document.Document	IndexedBuildResultsSearcher.findBuildResultByNumberAndKey(PlanKey planKey, int buildNumber) Find document identified by plan key and build result.

Uses of PlanKey in com.atlassian.bamboo.resultsummary.tests

Methods in com.atlassian.bamboo.resultsummary.tests with parameters of type PlanKey

Modifier and Type	Method and Description
long	TestResultsDao.countTestClassResults(PlanKey planKey) Count TestClassResults for a Plan
List<Pair<TestCase,Integer>>	TestsManager.getTopBrokenTests(PlanKey planKey, BuildResultsFilter filter) Returns a pai of the top 10 tests that's broken + the count for a given filter period
List<Pair<Long,Integer>>	TestCaseDao.getTopBrokenTests(PlanKey planKey, BuildResultsFilter filter)
int	TestsManager.removeResultsByPlan(PlanKey planKey) Remove all TestClassResult objects referenced by ResultsSummary objects identified by planKey
int	TestResultsDao.removeTestClassResultsByPlan(PlanKey planKey) Remove all TestClassResult objects referenced by ResultsSummary objects identified by planKey

Uses of PlanKey in com.atlassian.bamboo.resultsummary.vcs

Methods in com.atlassian.bamboo.resultsummary.vcs with parameters of type PlanKey

Modifier and Type	Method and Description
List<RepositoryChangeset>	RepositoryChangesetDao.getChangesetsForBuildNumberRange(PlanKey planKey, int firstBuildNumber, int lastBuildNumber) Finds and returns all repository change sets related with build results from specified range.

Uses of PlanKey in com.atlassian.bamboo.security

Methods in com.atlassian.bamboo.security with parameters of type PlanKey

Modifier and Type	Method and Description
Collection<org.acegisecurity.acls.Permission>	BambooPermissionManager.getPermissionsForPlan(PlanKey planKey)
boolean	BambooPermissionManager.hasPlanPermission(org.acegisecurity.acls.Permission permission, PlanKey planKey) Verify plan access

Uses of PlanKey in com.atlassian.bamboo.task

Methods in com.atlassian.bamboo.task with parameters of type PlanKey

Modifier and Type	Method and Description
TaskDefinition	TaskConfigurationService.createTask(PlanKey planKey, TaskModuleDescriptor taskDescriptor, String userDescription, boolean isEnabled, Map<String,String> configuration, TaskRootDirectorySelector taskRootDirectorySelector) Create a task Definition and save it against the plan
void	TaskConfigurationService.createTaskList(PlanKey planKey, List<TaskDefinition> taskDefinitions) Initializes task list of a plan with the provided list.
void	TaskConfigurationService.deleteTask(PlanKey planKey, long taskId) Delete a given taskDefinition
TaskDefinition	TaskConfigurationService.editTask(PlanKey planKey, long taskId, String userDescription, boolean isEnabled, Map<String,String> taskConfigurationMap, TaskRootDirectorySelector taskRootDirectorySelector) Update the details of specific taskDefinition
Collection<Requirement>	TaskConfigurationService.getTasksRequirements(PlanKey planKey) Return Requirements for all tasks of Plan represented by PlanKey
void	TaskConfigurationService.moveFinalBar(PlanKey planKey, long beforeId, long afterId) Moves the final Bar to a specific location in the list.
void	TaskConfigurationService.moveTask(PlanKey planKey, long taskId, long beforeId, long afterId, boolean isFinal) Move a taskDefinition from one spot in its list, to another.
TaskDefinition	TaskConfigurationService.setTaskState(PlanKey planKey, long taskId, boolean isEnabled) Update the disable state of specific taskDefinition

Uses of PlanKey in com.atlassian.bamboo.trigger

Methods in com.atlassian.bamboo.trigger that return PlanKey

Modifier and Type	Method and Description
PlanKey	TriggerableInternalKey.getPlanKey() Returns a PlanKey associated with this key if the source is actually a Plan

Methods in com.atlassian.bamboo.trigger with parameters of type PlanKey

Modifier and Type	Method and Description
TriggerDefinition	TriggerConfigurationService.createTrigger(PlanKey planKey, TriggerModuleDescriptor triggerModuleDescriptor, String userDescription, boolean isEnabled, Set<Long> triggeringRepositories, Map<String,String> configuration, Map<String,String> triggerConditionsConfiguration) Create a trigger Definition and save it against the plan
void	TriggerConfigurationService.createTriggerList(PlanKey planKey, List<TriggerDefinition> triggerDefinitions) Initializes trigger list of a plan with the provided list.
void	TriggerConfigurationService.deleteTrigger(PlanKey planKey, long triggerId) Delete a given trigger Definition
TriggerDefinition	TriggerConfigurationService.editTrigger(PlanKey planKey, long triggerId, String userDescription, boolean isEnabled, Set<Long> triggeringRepositories, Map<String,String> triggerConfigurationMap, Map<String,String> triggerConditionsConfiguration) Update the details of specific triggerDefinition

Uses of PlanKey in com.atlassian.bamboo.util

Methods in com.atlassian.bamboo.util with parameters of type PlanKey

Modifier and Type	Method and Description
static String	UrlUtils.replacePlanResultKeyInUrl(String url, PlanKey planKey, int newBuildNumber)

Uses of PlanKey in com.atlassian.bamboo.v2.build

Methods in com.atlassian.bamboo.v2.build with parameters of type PlanKey

Modifier and Type	Method and Description
void	ConfigurablePlugin.customizeBuildRequirements(PlanKey planKey, BuildConfiguration buildConfiguration, RequirementSet requirementSet) Extension point for adding/customizing requirements when editing a build's builder configuration.
void	ConfigurablePlugin.removeBuildRequirements(PlanKey planKey, BuildConfiguration buildConfiguration, RequirementSet requirementSet) Extension point for removing requirements when given plugin is excluded from build's builder configuration.

Uses of PlanKey in com.atlassian.bamboo.v2.build.queue

Methods in com.atlassian.bamboo.v2.build.queue with parameters of type PlanKey

Modifier and Type	Method and Description
void	BuildQueueManager.removeAllBuildsForPlanFromQueue(PlanKey planKey) Deprecated. since 5.5 use QueueManagerUtils.removeFromQueue(BuildQueueManager, com.atlassian.bamboo.Key)

Uses of PlanKey in com.atlassian.bamboo.v2.build.repository

Methods in com.atlassian.bamboo.v2.build.repository with parameters of type PlanKey

Modifier and Type	Method and Description
File	RepositoryV2.getSourceCodeDirectory(PlanKey planKey) Deprecated. since 3.3 Repository must handle checkout to any sub-directory.

Uses of PlanKey in com.atlassian.bamboo.v2.build.requirement

Methods in com.atlassian.bamboo.v2.build.requirement with parameters of type PlanKey

Modifier and Type	Method and Description
ImmutableRequirement	RequirementService.addRequirement(PlanKey jobKey, String key, ImmutableRequirement.MatchType matchType, String matchValue) Add new requirement to a job.
ExecutableAgentsMatrix	RequirementService.getExecutableAgentMatrixForJob(PlanKey jobKey) retrieve all executable agents for a particular job.
ImmutableRequirement	RequirementService.getRequirementForJob(PlanKey jobKey, long requirementId) Get a single requirement for a job.
List<? extends ImmutableRequirement>	RequirementService.getRequirementsForJob(PlanKey jobKey) Get all requirements for jobs.
void	RequirementService.removeRequirement(PlanKey jobKey, long requirementId) Remove a specific requirement
ImmutableRequirement	RequirementService.updateRequirement(PlanKey jobKey, long requirementId, String key, ImmutableRequirement.MatchType matchType, String matchValue) Update an existing requirement.
ErrorCollection	RequirementService.validateRequirementForAdd(PlanKey jobKey, String key, ImmutableRequirement.MatchType matchType, String matchValue) Validate requirement details.
ErrorCollection	RequirementService.validateRequirementForUpdate(PlanKey jobKey, long requirementId, String key, ImmutableRequirement.MatchType matchType, String matchValue) Validate requirement details

Uses of PlanKey in com.atlassian.bamboo.v2.build.trigger

Methods in com.atlassian.bamboo.v2.build.trigger with parameters of type PlanKey

Modifier and Type	Method and Description
boolean	DependencyBlockingManager.isBlockedFromBuilding(PlanKey planKey) Checks if build should be blocked, and executes any parent builds if required.
boolean	DependencyBlockingManager.isBlockedFromBuilding(PlanKey planKey, Set<? extends ImmutablePlan> siblings) Checks if build should be blocked, and executes any parent builds if required.