com.atlassian.bamboo.plan
Interface Plan

All Superinterfaces:
BambooIdProvider, BambooObject, Deletable, Describable, DescriptionProvider, ImmutableDeletable, ImmutablePlan, NameProvider, PlanIdentifier
All Known Subinterfaces:
Buildable, Chain, ChainBranch, Job, TopLevelPlan
All Known Implementing Classes:
AbstractChain, AbstractPlan, ChainBranchImpl, DefaultChain, DefaultJob, PlanPermissionSkeleton

public interface Plan
extends BambooObject, 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
 
Method Summary
 BuildDefinitionForBuild getBuildDefinitionXml()
           
 java.util.List<Labelling> getLabellings()
          Deprecated. 3.4
 ResultsSummary getLatestResultsSummary()
          Get the latest finished result
 java.util.List<Labelling> getRelatedLabellings()
          Returns labellings that's application for the plan level
 void setBuildDefinitionXml(BuildDefinitionForBuild buildDefinitionXml)
           
 void setBuildKey(java.lang.String buildKey)
          Define the build's unique key (uppercase alphanumeric)
 void setBuildName(java.lang.String buildName)
           
 void setFirstBuildNumber(int firstBuildNumber)
           
 void setKey(java.lang.String fullKey)
           
 void setLabellings(java.util.List<Labelling> labellings)
           
 void setLastBuildNumber(int lastBuildNumber)
           
 void setMaster(Plan master)
          Set which plan is the master of this plan.
 void setNextBuildNumber(int nextBuildNumber)
           
 void setPlanKey(PlanKey planKey)
           
 void setProject(Project project)
           
 void setSuspendedFromBuilding(boolean suspendFromBuilding)
          Sets the build to suspend temporarily
 ErrorCollection validateBuild()
          Deprecated. Ununsed. Since v3.4.
 
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.ImmutableDeletable
isMarkedForDeletion
 
Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlan
getAverageBuildDuration, getBuildDefinition, getBuildLogger, getCurrentStatus, getEffectiveVariables, getFirstBuildNumber, getKey, getLabelNames, getLastBuildNumber, getMaster, getNextBuildNumber, getProject, getType, getVariables, hasMaster, isActive, isBusy, isExecuting, isMarkedForDeletion
 
Methods inherited from interface com.atlassian.bamboo.plan.PlanIdentifier
getBuildKey, getBuildName, getId, getMasterId, getName, getPlanKey, getPlanType, isSuspendedFromBuilding
 
Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider
getDescription
 

Method Detail

setKey

void setKey(java.lang.String fullKey)
Parameters:
fullKey -

setPlanKey

void setPlanKey(@NotNull
                PlanKey planKey)

setBuildKey

void setBuildKey(java.lang.String buildKey)
Define the build's unique key (uppercase alphanumeric)

Parameters:
buildKey - The value of the key

setBuildName

void setBuildName(java.lang.String buildName)

setFirstBuildNumber

void setFirstBuildNumber(int firstBuildNumber)

setLastBuildNumber

void setLastBuildNumber(int lastBuildNumber)

setNextBuildNumber

void setNextBuildNumber(int nextBuildNumber)

setSuspendedFromBuilding

void setSuspendedFromBuilding(boolean suspendFromBuilding)
Sets the build to suspend temporarily

Parameters:
suspendFromBuilding -

getBuildDefinitionXml

@Nullable
BuildDefinitionForBuild getBuildDefinitionXml()

setBuildDefinitionXml

void setBuildDefinitionXml(@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
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(java.util.List<Labelling> labellings)

getRelatedLabellings

@NotNull
java.util.List<Labelling> getRelatedLabellings()
Returns labellings that's application for the plan level

Returns:
Empty list if no labels

getLabellings

@NotNull
@Deprecated
java.util.List<Labelling> getLabellings()
Deprecated. 3.4

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

Returns:

validateBuild

@Deprecated
ErrorCollection validateBuild()
Deprecated. Ununsed. Since v3.4.

Validates the build's builder and source code locations

Returns:
and ErrorCollection with relevent error messages


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.