com.atlassian.bamboo.ww2.beans

Interface DecoratedNavObject

All Known Implementing Classes:

DecoratedPlan, DecoratedPlan.DecoratedBranch, DecoratedResult

public interface DecoratedNavObject

Represents an item in the navigation context

Method Summary

Modifier and Type	Method and Description
@NotNull String	getDisplayName()
@NotNull String	getKey()
@Nullable PlanIdentifier	getMaster() The master plan iff the plan is a branched plan and it has a master.
@NotNull com.google.common.collect.ImmutableList<? extends DecoratedNavGroupObject>	getNavGroups()
@Nullable DecoratedNavObject	getParent()
@NotNull PlanType	getPlanType()
@Nullable DecoratedNavObjectStatus	getStatus()
@NotNull String	getType()
boolean	isResult()
@Nullable 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

Method Detail

getKey

@NotNull
@NotNull String getKey()

Returns:

full key of the object

getDisplayName

@NotNull
@NotNull String getDisplayName()

Returns:

display name of this object

getNavGroups

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

Returns:

any children groups of this object

getParent

@Nullable
@Nullable DecoratedNavObject getParent()

Returns:

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

getPlanType

@NotNull
@NotNull PlanType getPlanType()

Returns:

plantype associated with this object.

getType

@NotNull
@NotNull String getType()

Returns:

plantype associated with this object.

isResult

boolean isResult()

Returns:

true if the nav object represents a result otherwise false

getStatus

@Nullable
@Nullable DecoratedNavObjectStatus getStatus()

Returns:

provide the status of this object if applicable

replaceKey

@Nullable
@Nullable 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

Parameters:

url - - to manipulate

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

Returns:

the new url referencing this object

getMaster

@Nullable
@Nullable PlanIdentifier getMaster()

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

Returns: