com.atlassian.bamboo.plan
Interface PlanIdentifier

All Superinterfaces:

BambooIdProvider, DescriptionProvider, NameProvider

All Known Subinterfaces:

Buildable, Chain, ChainBranch, ChainBranchIdentifier, ImmutableChain, ImmutableChainBranch, ImmutableJob, ImmutablePlan, ImmutableTopLevelPlan, Job, Plan, TopLevelPlan

All Known Implementing Classes:

AbstractChain, AbstractImmutableChain, AbstractImmutablePlan, AbstractPlan, BuildObjectForTests, ChainBranchIdentifierImpl, ChainBranchImpl, DecoratedPlan, DefaultChain, DefaultJob, ImmutableChainBranchImpl, ImmutableChainImpl, ImmutableJobImpl, PlanIdentifierImpl, PlanPermissionSkeleton, TestBuildObjectForTests

public interface PlanIdentifier
extends BambooIdProvider, DescriptionProvider

Represents the minimal information about a Plan

Since:

v4.0

Method Summary

java.lang.String	getBuildKey() This objects specific portion of the key.
java.lang.String	getBuildName()
long	getId()
java.lang.String	getName() Returns the full name for the build in the form of "project name - build name" e.g.
PlanKey	getPlanKey() Get the PlanKey identifier for this Plan
PlanType	getPlanType()
ProjectIdentifier	getProject() Returns the parent Project
boolean	isSuspendedFromBuilding() Checks if the build has been enabled / disabled.

Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider

getDescription

Method Detail

getId

long getId()

Specified by:

getId in interface BambooIdProvider

Returns:

Database id of the plan

getPlanType

@NotNull
PlanType getPlanType()

Returns:

the type of this plan

getPlanKey

@NotNull
PlanKey getPlanKey()

Get the PlanKey identifier for this Plan

Returns:

planKey

getBuildKey

@NotNull
java.lang.String getBuildKey()

This objects specific portion of the key. You probably want to use getPlanKey().

Returns:

This objects specific portion of the key

getName

@NotNull
java.lang.String getName()

Returns the full name for the build in the form of "project name - build name" e.g. "Confluence - HEAD"

Specified by:

getName in interface DescriptionProvider

Specified by:

getName in interface NameProvider

Returns:

String

getBuildName

@NotNull
java.lang.String getBuildName()

Returns:

The plan specific portion of the name (without the project and/or parent's names). You probably want to use getName()

isSuspendedFromBuilding

boolean isSuspendedFromBuilding()

Checks if the build has been enabled / disabled.

Returns:

true if plan is disabled

getProject

@NotNull
ProjectIdentifier getProject()

Returns the parent Project

Returns:

Project. Never null