com.atlassian.bamboo.build
Interface Buildable

All Superinterfaces:
BambooObject, Deletable, Describable, DescriptionProvider, NameProvider, Plan
All Known Subinterfaces:
Build, Job
All Known Implementing Classes:
AbstractBuildable, BuildObjectForTests, DefaultBuild, DefaultJob, TestBuildObjectForTests

public interface Buildable
extends Plan


Field Summary
 
Fields inherited from interface com.atlassian.bamboo.plan.Plan
MAX_NUMBER_LOG_ENTRIES, MAX_PREVIOUS_BUILD_FOR_AVE, STATUS_CURRENTLY_BUILDING, STATUS_FAIL, STATUS_NO_BUILDS, STATUS_NOT_RUN, STATUS_SUCCESS
 
Method Summary
 void addBuildResultSummary(BuildResultsSummary buildResultsSummary)
          Add the given build results summary to the build.
 java.util.List<BuildResultsSummary> getBuildResultSummaries()
          Obtains the builds total collection of BuildResultsSummary objects (oldest first), one for each build.
 BuildResultsSummary getFirstBuildSummary()
          Get the first build result
 BuildResultsSummary getLatestBuildSummary()
          Get the summary from the latest completed build
 BuildResults getNextBuildResults(int buildNumber)
           
 int getNumberOfConcurrentlyRunningBuilds()
          Gets the number of currently running concurrent build instances for the build
 BuildResults getPreviousBuildResults(int buildNumber)
          Gets the first BuildResultsImpl before the passed number
 RequirementSet getRequirementSet()
           
 boolean hasBuildResults()
          Has the build got any build results to display?
 boolean isInBuildQueue()
          Deprecated. since 2.7 use isActive
 void removeBuildResultSummary(int buildNumber)
          Remove buildResultSummary and all persisted files for given build number
 void setRequirementSet(RequirementSet requirementSet)
           
 
Methods inherited from interface com.atlassian.bamboo.plan.Plan
getAverageBuildDuration, getBuildDefinition, getBuildDefinitionXml, getBuildKey, getBuildLogger, getBuildName, getCurrentStatus, getFirstBuildNumber, getKey, getLabellings, getLabelNames, getLastBuildNumber, getLastVcsRevisionKey, getLatestResultsSummary, getName, getNextBuildNumber, getPlanKey, getProject, getRelatedLabellings, getSourceCodeDirectory, getType, hasTests, isActive, isBusy, isExecuting, isSuspendedFromBuilding, setBuildDefinitionXml, setBuildKey, setBuildName, setFirstBuildNumber, setKey, setLabellings, setLastBuildNumber, setLastVcsRevisionKey, setNextBuildNumber, setProject, setSuspendedFromBuilding, validateBuild
 
Methods inherited from interface com.atlassian.bamboo.Describable
setDescription, setName
 
Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider
getDescription
 
Methods inherited from interface com.atlassian.bamboo.deletion.Deletable
isMarkedForDeletion, setMarkedForDeletion
 
Methods inherited from interface com.atlassian.bamboo.core.BambooObject
getId, setId
 

Method Detail

getRequirementSet

@NotNull
RequirementSet getRequirementSet()

setRequirementSet

void setRequirementSet(RequirementSet requirementSet)

getBuildResultSummaries

java.util.List<BuildResultsSummary> getBuildResultSummaries()
Obtains the builds total collection of BuildResultsSummary objects (oldest first), one for each build.

Returns:
The collection of build summary objects

getLatestBuildSummary

@Nullable
BuildResultsSummary getLatestBuildSummary()
Get the summary from the latest completed build

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

getFirstBuildSummary

BuildResultsSummary getFirstBuildSummary()
Get the first build result

Returns:
result

hasBuildResults

boolean hasBuildResults()
Has the build got any build results to display?

Returns:
true if the build has been built, false otherwise

addBuildResultSummary

void addBuildResultSummary(BuildResultsSummary buildResultsSummary)
Add the given build results summary to the build.

Parameters:
buildResultsSummary - The build summary

removeBuildResultSummary

void removeBuildResultSummary(int buildNumber)
Remove buildResultSummary and all persisted files for given build number

Parameters:
buildNumber -

getPreviousBuildResults

@Nullable
BuildResults getPreviousBuildResults(int buildNumber)
Gets the first BuildResultsImpl before the passed number

Parameters:
buildNumber -
Returns:
BuildResultsImpl. null if no build results can be found before that number

getNextBuildResults

@Nullable
BuildResults getNextBuildResults(int buildNumber)

isInBuildQueue

@Deprecated
boolean isInBuildQueue()
Deprecated. since 2.7 use isActive

Is the build currenlty being built?

Returns:
true if is currently in the build pipleline

getNumberOfConcurrentlyRunningBuilds

int getNumberOfConcurrentlyRunningBuilds()
Gets the number of currently running concurrent build instances for the build

Returns:


Copyright © 2011 Atlassian. All Rights Reserved.