com.atlassian.bamboo.plan

Interface Plan

All Superinterfaces:

BambooIdProvider, BambooObject, BambooObjectWithOid, Deletable, Describable, DescriptionProvider, EntityWithOid, ImmutableDeletable, ImmutableEntityWithOid, ImmutablePlan, NameProvider, PlanIdentifier, PlanKeyProvider

All Known Subinterfaces:

Buildable, Chain, ChainBranch, Job, TopLevelPlan

All Known Implementing Classes:

AbstractChain, AbstractPlan, ChainBranchImpl, DefaultChain, DefaultJob

@PublicApi
public interface Plan
extends BambooObjectWithOid, Describable, Deletable, ImmutablePlan

Mutable version of the plan.

Field Summary

Fields inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlan

MAX_NUMBER_LOG_ENTRIES, MAX_PREVIOUS_BUILD_FOR_AVE, STATUS_CURRENTLY_BUILDING, STATUS_FAIL, STATUS_NO_BUILDS, STATUS_NOT_RUN, STATUS_SUCCESS

Fields inherited from interface com.atlassian.bamboo.plan.PlanIdentifier

NAME_DELIMITER

Fields inherited from interface com.atlassian.bamboo.plan.PlanKeyProvider

getPlanKey

Method Summary

Modifier and Type	Method and Description
@Nullable BuildDefinitionForBuild	getBuildDefinitionXml()
@NotNull List<Labelling>	getLabellings() Deprecated. 3.4
@Nullable ResultsSummary	getLatestResultsSummary() Get the latest finished result
@NotNull List<Labelling>	getRelatedLabellings() Returns labellings that are applicable for the plan level
void	setBuildDefinitionXml(@Nullable BuildDefinitionForBuild buildDefinitionXml)
void	setBuildKey(String buildKey) Define the build's unique key (uppercase alphanumeric)
void	setBuildName(String buildName)
void	setKey(String fullKey)
void	setLabellings(List<Labelling> labellings)
void	setMaster(Plan master) Set which plan is the master of this plan.
void	setPlanKey(@NotNull PlanKey planKey)
void	setProject(Project project)
void	setSuspendedFromBuilding(boolean suspendFromBuilding) Sets the build to suspend temporarily

Methods inherited from interface com.atlassian.bamboo.core.EntityWithOid

setOid

Methods inherited from interface com.atlassian.bamboo.core.ImmutableEntityWithOid

getEntityType, getOid

Methods inherited from interface com.atlassian.bamboo.Describable

setDescription, setName

Methods inherited from interface com.atlassian.bamboo.deletion.Deletable

setMarkedForDeletion

Methods inherited from interface com.atlassian.bamboo.core.BambooObject

setId

Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlan

getAverageBuildDuration, getBuildDefinition, getBuildLogger, getCurrentStatus, getEffectiveVariables, getFirstBuildNumber, getKey, getLabelNames, getLastBuildNumber, getMaster, getProject, getType, getVariables, hasMaster, isActive, isBusy, isExecuting, isMarkedForDeletion

Methods inherited from interface com.atlassian.bamboo.plan.PlanIdentifier

getBuildKey, getBuildName, getDatabaseId, getId, getMasterId, getMasterIdIfExists, getName, getPlanKey, getPlanType, isSuspendedFromBuilding

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

getDescription

Method Detail

setKey

void setKey(String fullKey)

Parameters:

fullKey -

setPlanKey

void setPlanKey(@NotNull
                @NotNull PlanKey planKey)

setBuildKey

void setBuildKey(String buildKey)

Define the build's unique key (uppercase alphanumeric)

Parameters:

buildKey - The value of the key

setBuildName

void setBuildName(String buildName)

setSuspendedFromBuilding

void setSuspendedFromBuilding(boolean suspendFromBuilding)

Sets the build to suspend temporarily

Parameters:

suspendFromBuilding -

getBuildDefinitionXml

@Nullable
@Nullable BuildDefinitionForBuild getBuildDefinitionXml()

setBuildDefinitionXml

void setBuildDefinitionXml(@Nullable
                           @Nullable BuildDefinitionForBuild buildDefinitionXml)

setMaster

void setMaster(Plan master)

Set which plan is the master of this plan. The master is the plan which this one is derived from. Configuration is pulled from the master if one exists.

Parameters:

master -

setProject

void setProject(Project project)

getLatestResultsSummary

@Nullable
@Nullable ResultsSummary getLatestResultsSummary()

Description copied from interface: ImmutablePlan

Get the latest finished result

Specified by:

getLatestResultsSummary in interface ImmutablePlan

Returns:

The summary info for the last completed build. Returns null if there are no build results for this plan

setLabellings

void setLabellings(List<Labelling> labellings)

getRelatedLabellings

@NotNull
@NotNull List<Labelling> getRelatedLabellings()

Returns labellings that are applicable for the plan level

Returns:

Empty list if no labels

getLabellings

@NotNull
 @Deprecated
@NotNull List<Labelling> getLabellings()

Deprecated. 3.4

Used only for Hibernate mapping purposes. Deprecated for removal from the interface

Returns: