com.atlassian.bamboo.resultsummary
Interface BuildResultsSummary

All Superinterfaces:
java.lang.Comparable<BuildResultsSummary>, ResultStatisticsProvider
All Known Subinterfaces:
ExtendedBuildResultsSummary
All Known Implementing Classes:
AbstractBuildResultsSummary, BuildResultsSummaryDocument, BuildResultsSummaryForTesting, BuildResultsSummaryImpl

public interface BuildResultsSummary
extends ResultStatisticsProvider, java.lang.Comparable<BuildResultsSummary>

An interface which provides a database persisted version of the BuildResults


Method Summary
 java.util.Collection<ArtifactLink> getAllArtifactLinks()
          Returns all artifacts.
 java.util.Collection<ArtifactLink> getArtifactLinks()
          Returns only artifacts that exists
 java.lang.Long getBuildAgentId()
          The agent Id
 java.util.Date getBuildCompletedDate()
          When the build finished
 java.lang.String getBuildKey()
          Full key of the plan.
 java.lang.String getBuildResultKey()
          A full build result key e.g.
 java.lang.String getBuildTime()
          Formatted buildDate.
 java.lang.String getChangedByAuthors()
           
 java.util.List<Comment> getComments()
          Gets the associated user comments for the build
 java.util.Map<java.lang.String,java.lang.String> getCustomBuildData()
          Custom data map to store random metadata about the build
 DeltaState getDeltaState()
          Gets the DeltaState of the summary.
 long getDuration()
          Duration of the build in millisecods
 java.lang.String getDurationDescription()
          Returns the duration in a "pretty" format.
 long getFailedTestCount()
          Number of failing tests
 java.util.Set<LinkedJiraIssue> getFixingJiraIssues()
          Return JIRA issues that this build result summary fixes
 long getId()
          Database id of the result
 java.util.Set<java.lang.String> getJiraIssueKeys()
          Returns all the JIRA issue keys linked to this build result
 java.util.Set<LinkedJiraIssue> getJiraIssues()
          Returns all the JIRA issues linked to this build result
 java.util.List<Labelling> getLabellings()
          Tags / labels assocaited with the build
 java.util.List<java.lang.String> getLabelNames()
          A shortcust method to get all of the label names from the labbellings
 long getQueueDuration()
          How long build was in the queue (in miliseconds)
 java.util.Date getQueueTime()
          When the build queued
 java.lang.String getReasonSummary()
           
 java.util.Set<LinkedJiraIssue> getRelatedJiraIssues()
          Returns JIRA issues that are related to this build result.
 java.lang.String getRelativeBuildDate()
           
 java.lang.String getRelativeBuildDate(java.util.Date comparedTo)
           
 long getSuccessfulTestCount()
          Number of successful tests
 java.lang.String getTestSummary()
           
 java.lang.Long getTimeToFix()
          A stored version of how long (milli seconds) it took for this build to fix a failure.
 TriggerReason getTriggerReason()
          Why the build was was triggered
 java.util.Set<Author> getUniqueAuthors()
          A shortcut method to get the unique set of authors contributing to this build.
 java.lang.String getVcsRevisionKey()
          The string representing the revision when the build was run.
 long getVcsUpdateDuration()
          How long checkout take (in miliseconds)
 java.util.Date getVcsUpdateTime()
          When the source syncronisation was kicked off
 boolean isFailed()
          Shortcut method to see if ResultStatisticsProvider.getBuildState() is BuildState.FAILED
 boolean isSuccessful()
          Shortcut method to see if ResultStatisticsProvider.getBuildState() is BuildState.SUCCESS
 void setVcsRevisionKey(java.lang.String vcsRevisionKey)
           
 
Methods inherited from interface com.atlassian.bamboo.resultsummary.ResultStatisticsProvider
getBuildDate, getBuildNumber, getBuildState, getDurationInSeconds
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getId

long getId()
Database id of the result

Returns:

getBuildKey

@NotNull
java.lang.String getBuildKey()
Full key of the plan. e.g BAM-MAIN

Returns:

getBuildResultKey

@NotNull
java.lang.String getBuildResultKey()
A full build result key e.g. BAM-MAIN-100

Returns:
String

getTriggerReason

@NotNull
TriggerReason getTriggerReason()
Why the build was was triggered

Returns:

getVcsRevisionKey

@Nullable
java.lang.String getVcsRevisionKey()
The string representing the revision when the build was run. This is Repository specific, so may not correspond and thus be parseable by the current repository configuration. May return null since this data is not always available

Returns:

setVcsRevisionKey

void setVcsRevisionKey(java.lang.String vcsRevisionKey)

getDeltaState

DeltaState getDeltaState()
Gets the DeltaState of the summary. It can be a build that fixes, breaks, failing, successfull. Provides a status relative to the previous summary.

Returns:

getDuration

long getDuration()
Duration of the build in millisecods

Returns:

getBuildCompletedDate

java.util.Date getBuildCompletedDate()
When the build finished

Returns:

isFailed

boolean isFailed()
Shortcut method to see if ResultStatisticsProvider.getBuildState() is BuildState.FAILED

Returns:

isSuccessful

boolean isSuccessful()
Shortcut method to see if ResultStatisticsProvider.getBuildState() is BuildState.SUCCESS

Returns:

getBuildAgentId

java.lang.Long getBuildAgentId()
The agent Id

Returns:

getCustomBuildData

@NotNull
java.util.Map<java.lang.String,java.lang.String> getCustomBuildData()
Custom data map to store random metadata about the build

Returns:

getJiraIssues

@NotNull
java.util.Set<LinkedJiraIssue> getJiraIssues()
Returns all the JIRA issues linked to this build result

Returns:

getFixingJiraIssues

@NotNull
java.util.Set<LinkedJiraIssue> getFixingJiraIssues()
Return JIRA issues that this build result summary fixes

Returns:

getRelatedJiraIssues

@NotNull
java.util.Set<LinkedJiraIssue> getRelatedJiraIssues()
Returns JIRA issues that are related to this build result. Does not include fixing issues

Returns:

getJiraIssueKeys

java.util.Set<java.lang.String> getJiraIssueKeys()
Returns all the JIRA issue keys linked to this build result

Returns:

getComments

@NotNull
java.util.List<Comment> getComments()
Gets the associated user comments for the build

Returns:

getLabellings

java.util.List<Labelling> getLabellings()
Tags / labels assocaited with the build

Returns:

getLabelNames

@NotNull
java.util.List<java.lang.String> getLabelNames()
A shortcust method to get all of the label names from the labbellings

Returns:

getUniqueAuthors

java.util.Set<Author> getUniqueAuthors()
A shortcut method to get the unique set of authors contributing to this build.

Returns:
Set of Authors

getTimeToFix

@Nullable
java.lang.Long getTimeToFix()
A stored version of how long (milli seconds) it took for this build to fix a failure.

Returns:
Null if not a fixing build

getFailedTestCount

long getFailedTestCount()
Number of failing tests

Returns:

getSuccessfulTestCount

long getSuccessfulTestCount()
Number of successful tests

Returns:

getDurationDescription

@NotNull
java.lang.String getDurationDescription()
Returns the duration in a "pretty" format. Handles when duration is not known

Returns:

getReasonSummary

java.lang.String getReasonSummary()

getRelativeBuildDate

java.lang.String getRelativeBuildDate()

getChangedByAuthors

java.lang.String getChangedByAuthors()

getTestSummary

java.lang.String getTestSummary()

getRelativeBuildDate

java.lang.String getRelativeBuildDate(java.util.Date comparedTo)

getBuildTime

java.lang.String getBuildTime()
Formatted buildDate. When the build was started

Returns:

getAllArtifactLinks

@NotNull
java.util.Collection<ArtifactLink> getAllArtifactLinks()
Returns all artifacts. Even if the files don't exist

Returns:

getArtifactLinks

java.util.Collection<ArtifactLink> getArtifactLinks()
Returns only artifacts that exists

Returns:

getQueueTime

@Nullable
java.util.Date getQueueTime()
When the build queued

Returns:

getQueueDuration

long getQueueDuration()
How long build was in the queue (in miliseconds)

Returns:

getVcsUpdateTime

@Nullable
java.util.Date getVcsUpdateTime()
When the source syncronisation was kicked off

Returns:

getVcsUpdateDuration

long getVcsUpdateDuration()
How long checkout take (in miliseconds)

Returns:


Copyright © 2009 Atlassian Pty Ltd. All Rights Reserved.