com.atlassian.bamboo.ww2.beans

Class DecoratedResult

java.lang.Object

com.atlassian.bamboo.ww2.beans.DecoratedResult

All Implemented Interfaces:

DecoratedNavObject

public abstract class DecoratedResult
extends Object
implements DecoratedNavObject

Method Summary

Modifier and Type	Method and Description
static DecoratedResult	decorateChainResult(ChainResultsSummary resultsSummary, DecoratedPlan decoratedPlan) Decorate a ChainResultsSummary.
com.google.common.collect.ImmutableList<DecoratedPlan>	getBranches()
String	getBranchName()
Date	getBuildDate()
int	getBuildNumber()
String	getDescription()
String	getDisplayName()
String	getFullName()
String	getKey()
String	getLinkedJiraIssue()
PlanIdentifier	getMaster() The master plan iff the plan is a branched plan and it has a master.
com.google.common.collect.ImmutableList<? extends DecoratedNavGroupObject>	getNavGroups()
abstract DecoratedResult	getParent()
String	getPlanKey()
PlanResultKey	getPlanResultKey()
PlanType	getPlanType()
String	getProjectKey()
String	getProjectName()
abstract com.google.common.collect.ImmutableList<DecoratedStageResult>	getStageResults()
DecoratedNavObjectStatus	getStatus()
String	getType()
boolean	isRemoteJiraLinkRequired()
boolean	isResult()
boolean	isSuspendedFromBuilding()
String	replaceKey(String url, DecoratedNavObject originalObject) Given an existing url (may be directly from the originalObject or may be with a static ${planKey} reference) generate the new url for this object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

decorateChainResult

@Nullable
public static DecoratedResult decorateChainResult(@NotNull
                                                            ChainResultsSummary resultsSummary,
                                                            @NotNull
                                                            DecoratedPlan decoratedPlan)

Decorate a ChainResultsSummary.

Parameters:

resultsSummary - summary to decorate

decoratedPlan - decorated plan the results summary is a result for. Must have the same key.

Returns:

a contextual decorator around resultsSummary or null if the job is an orphan.

Throws:

IllegalArgumentException - if the resultsSummary and decoratedPlan do not match.

getKey

@NotNull
public String getKey()

Specified by:

getKey in interface DecoratedNavObject

Returns:

full key of the object

getDisplayName

@NotNull
public String getDisplayName()

Specified by:

getDisplayName in interface DecoratedNavObject

Returns:

display name of this object

getNavGroups

@NotNull
public com.google.common.collect.ImmutableList<? extends DecoratedNavGroupObject> getNavGroups()

Specified by:

getNavGroups in interface DecoratedNavObject

Returns:

any children groups of this object

getParent

@Nullable
public abstract DecoratedResult getParent()

Specified by:

getParent in interface DecoratedNavObject

Returns:

the parent of this object (does not take into account groups)

getPlanType

@NotNull
public PlanType getPlanType()

Specified by:

getPlanType in interface DecoratedNavObject

Returns:

plantype associated with this object.

getMaster

@Nullable
public PlanIdentifier getMaster()

Description copied from interface: DecoratedNavObject

The master plan iff the plan is a branched plan and it has a master.

Specified by:

getMaster in interface DecoratedNavObject

Returns:

getDescription

public String getDescription()

getType

@NotNull
public String getType()

Specified by:

getType in interface DecoratedNavObject

Returns:

plantype associated with this object.

getStatus

@Nullable
public DecoratedNavObjectStatus getStatus()

Specified by:

getStatus in interface DecoratedNavObject

Returns:

provide the status of this object if applicable

isResult

public boolean isResult()

Specified by:

isResult in interface DecoratedNavObject

Returns:

true if the nav object represents a result otherwise false

getBranches

@Nullable
public com.google.common.collect.ImmutableList<DecoratedPlan> getBranches()

replaceKey

@Nullable
public String replaceKey(String url,
                                   DecoratedNavObject originalObject)

Description copied from interface: DecoratedNavObject

Given an existing url (may be directly from the originalObject or may be with a static ${planKey} reference) generate the new url for this object

Specified by:

replaceKey in interface DecoratedNavObject

Parameters:

url - - to manipulate

originalObject - - the object the original url may have belonged to

Returns:

the new url referencing this object

getPlanKey

public String getPlanKey()

getBuildNumber

public int getBuildNumber()

getPlanResultKey

public PlanResultKey getPlanResultKey()

getProjectKey

public String getProjectKey()

getProjectName

public String getProjectName()

getFullName

public String getFullName()

getStageResults

public abstract com.google.common.collect.ImmutableList<DecoratedStageResult> getStageResults()

getBuildDate

public Date getBuildDate()

getBranchName

@Nullable
public String getBranchName()

getLinkedJiraIssue

@Nullable
public String getLinkedJiraIssue()

isRemoteJiraLinkRequired

public boolean isRemoteJiraLinkRequired()

isSuspendedFromBuilding

public boolean isSuspendedFromBuilding()