com.atlassian.bamboo.ww2.beans
Interface DecoratedNavObject
- All Known Implementing Classes:
- DecoratedPlan, DecoratedResult
public interface DecoratedNavObject
Represents an item in the navigation context
getKey
@NotNull
java.lang.String getKey()
- Returns:
- full key of the object
getDisplayName
@NotNull
java.lang.String getDisplayName()
- Returns:
- display name of this object
getNavGroups
@NotNull
com.google.common.collect.ImmutableList<? extends DecoratedNavGroupObject> getNavGroups()
- Returns:
- any children groups of this object
getParent
@Nullable
DecoratedNavObject getParent()
- Returns:
- the parent of this object (does not take into account groups)
getPlanType
@NotNull
PlanType getPlanType()
- Returns:
- plantype associated with this object.
getType
@NotNull
java.lang.String getType()
- Returns:
- plantype associated with this object.
isResult
boolean isResult()
- Returns:
- true if the nav object represents a result otherwise false
getStatus
@Nullable
DecoratedNavObjectStatus getStatus()
- Returns:
- provide the status of this object if applicable
replaceKey
@Nullable
java.lang.String replaceKey(java.lang.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 manipulateoriginalObject
- - the object the original url may have belonged to
- Returns:
- the new url referencing this object
Copyright © 2011 Atlassian. All Rights Reserved.