AbstractPlan (Atlassian Bamboo 7.1.2 API)

java.lang.Object
- com.atlassian.core.bean.EntityObject
- - com.atlassian.bamboo.core.BambooEntityObject
  - - com.atlassian.bamboo.core.BambooEntityWithOid
    - - com.atlassian.bamboo.hibernate.HibernateBambooEntityWithOid
      - com.atlassian.bamboo.plan.AbstractPlan

All Implemented Interfaces:

BambooIdProvider, BambooObject, BambooObjectWithOid, EntityWithOid, ImmutableEntityWithOid, Deletable, Describable, ImmutableDeletable, ImmutablePlan, Plan, PlanIdentifier, PlanKeyProvider, DescriptionProvider, NameProvider, Cloneable, Comparable<Plan>

Direct Known Subclasses:

AbstractChain, DefaultJob
```
@MappedSuperclass
public abstract class AbstractPlan
extends HibernateBambooEntityWithOid
implements ImmutablePlan, Plan, Comparable<Plan>
```
This plan is only partially migrated to annotation-based Hibernate model, to allow creating queries using the new query mechanism. "Plan.hbm.xml" is still the source of truth for this entity.

Field Summary

Fields
Modifier and Type Field and Description

protected ResultsSummaryManager resultsSummaryManager
- Fields inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlan
  MAX_NUMBER_LOG_ENTRIES, MAX_PREVIOUS_BUILD_FOR_AVE, STATUS_CURRENTLY_BUILDING, STATUS_FAIL, STATUS_NO_BUILDS, STATUS_NOT_RUN, STATUS_SUCCESS
- Fields inherited from interface com.atlassian.bamboo.plan.PlanIdentifier
  getPlanKeyFunction, NAME_DELIMITER
- Fields inherited from interface com.atlassian.bamboo.plan.PlanKeyProvider
  getPlanKey

Fields
Modifier and Type	Field and Description
`protected ResultsSummaryManager`	`resultsSummaryManager`

Constructor Summary

Constructors
Constructor and Description

AbstractPlan()

Constructors
Constructor and Description
`AbstractPlan()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`compareTo(Plan plan)`
`boolean`	`equals(Object o)`
`BuildDefinition`	`getBuildDefinition()` Returns the `BuildDefinition` that backs this `Plan`
`BuildDefinitionForBuild`	`getBuildDefinitionXml()`
`String`	`getBuildKey()` This objects specific portion of the key.
`BuildLogger`	`getBuildLogger()` Returns the helper object to deal with logging
`String`	`getBuildName()`
`Optional<Long>`	`getDatabaseId()`
`String`	`getDescription()`
`String`	`getDiscriminator()`
`List<VariableDefinition>`	`getEffectiveVariables()` Return effective list of `VariableDefinition`s bind to this Plan.
`int`	`getFirstBuildNumber()` What the number of the first build we have? It may not be 1 as some may have been removed!
`String`	`getKey()` Obtain the plan's unique key (uppercase alphanumeric).
`List<Labelling>`	`getLabellings()` Used only for Hibernate mapping purposes.
`List<String>`	`getLabelNames()`
`int`	`getLastBuildNumber()` What was the number of the latest build (may be being built)
`ResultsSummary`	`getLatestResultsSummary()` Get the latest finished result
`long`	`getMasterId()`
`Optional<Long>`	`getMasterIdIfExists()`
`String`	`getName()` Returns the full name for the build in the form of "project name - build name" e.g.
`PlanKey`	`getPlanKey()` Get the `PlanKey` identifier for this `Plan`
`Project`	`getProject()` Returns the parent `Project`
`List<Labelling>`	`getRelatedLabellings()` Returns labellings that are applicable for the plan level
`List<TestClass>`	`getTestClasses()` Deprecated. since 6.9 used to be used for persistence
`String`	`getType()` Returns the string representation of the type.
`List<VariableDefinition>`	`getVariables()` Return list of `VariableDefinition`s bind to this Plan
`int`	`hashCode()`
`boolean`	`hasMaster()`
`boolean`	`isBusy()` Is the `Plan` "busy".
`boolean`	`isMarkedForDeletion()` Is the plan set to be deleted in the future
`boolean`	`isSuspendedFromBuilding()` Checks if the build has been enabled / disabled.
`void`	`setBuildDefinitionManager(BuildDefinitionManager buildDefinitionManager)`
`void`	`setBuildDefinitionXml(BuildDefinitionForBuild buildDefinitionXml)`
`void`	`setBuildKey(String buildKey)` Define the build's unique key (uppercase alphanumeric)
`void`	`setBuildLoggerManager(BuildLoggerManager buildLoggerManager)`
`void`	`setBuildName(String buildName)`
`void`	`setDescription(String description)`
`void`	`setDiscriminator(String discriminator)`
`void`	`setKey(String fullKey)`
`void`	`setLabellings(List<Labelling> labellings)`
`void`	`setLabelManager(LabelManager labelManager)`
`void`	`setMarkedForDeletion(boolean markedForDeletion)`
`void`	`setName(String name)`
`void`	`setPlanExecutionManager(PlanExecutionManager planExecutionManager)`
`void`	`setPlanKey(PlanKey planKey)`
`void`	`setProject(Project project)`
`void`	`setResultsSummaryManager(ResultsSummaryManager resultsSummaryManager)`
`void`	`setSuspendedFromBuilding(boolean suspendedFromBuilding)` Sets the build to suspend temporarily
`void`	`setTestClasses(List<TestClass> testCases)` Deprecated. since 6.9 used to be used for persistence
`void`	`setVariableDefinitionManager(VariableDefinitionManager variableDefinitionManager)`

Methods inherited from class com.atlassian.bamboo.hibernate.HibernateBambooEntityWithOid
getId, getOid, setId, setOid

Methods inherited from class com.atlassian.core.bean.EntityObject
clone, getCreationDate, getCurrentDate, getLastModificationDate, setClock, setCreationDate, setLastModificationDate

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.bamboo.plan.Plan
setMaster

Methods inherited from interface com.atlassian.bamboo.core.EntityWithOid
setOid

Methods inherited from interface com.atlassian.bamboo.core.ImmutableEntityWithOid
getEntityType, getOid

Methods inherited from interface com.atlassian.bamboo.core.BambooObject
setId

Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlan
getAverageBuildDuration, getCurrentStatus, getMaster, isActive, isExecuting

Methods inherited from interface com.atlassian.bamboo.plan.PlanIdentifier
getId, getPlanType

- Field Detail
  - resultsSummaryManager
```
protected ResultsSummaryManager resultsSummaryManager
```
- Constructor Detail
  - AbstractPlan
```
public AbstractPlan()
```
- Method Detail
  - getDatabaseId
```
@NotNull
public Optional<Long> getDatabaseId()
```
    Specified by:
    
    getDatabaseId in interface PlanIdentifier
    
    Returns:
    
    database id of the plan or empty if this plan is not a DB object.
  - getPlanKey
```
@NotNull
public PlanKey getPlanKey()
```
    Description copied from interface: PlanIdentifier
    
    Get the PlanKey identifier for this Plan
    
    Specified by:
    
    getPlanKey in interface PlanIdentifier
    
    Specified by:
    
    getPlanKey in interface PlanKeyProvider
    
    Returns:
    
    planKey
  - getKey
```
@NotNull
public String getKey()
```
    Description copied from interface: ImmutablePlan
    
    Obtain the plan's unique key (uppercase alphanumeric). This includes the project prefix e.g. BAM-MAIN. Prefer PlanIdentifier.getPlanKey()
    
    Specified by:
    
    getKey in interface ImmutablePlan
    
    Returns:
    
    The full key
  - setKey
```
public void setKey(String fullKey)
```
    Specified by:
    
    setKey in interface Plan
  - setPlanKey
```
public void setPlanKey(@NotNull
                       PlanKey planKey)
```
    Specified by:
    
    setPlanKey in interface Plan
  - getBuildKey
```
@NotNull
public String getBuildKey()
```
    Description copied from interface: PlanIdentifier
    
    This objects specific portion of the key. You probably want to use PlanIdentifier.getPlanKey().
    
    Specified by:
    
    getBuildKey in interface PlanIdentifier
    
    Returns:
    
    This objects specific portion of the key
  - setBuildKey
```
public void setBuildKey(String buildKey)
```
    Description copied from interface: Plan
    
    Define the build's unique key (uppercase alphanumeric)
    
    Specified by:
    
    setBuildKey in interface Plan
    
    Parameters:
    
    buildKey - The value of the key
  - getName
```
@NotNull
public String getName()
```
    Description copied from interface: PlanIdentifier
    
    Returns the full name for the build in the form of "project name - build name" e.g. "Confluence - HEAD"
    
    Specified by:
    
    getName in interface PlanIdentifier
    
    Specified by:
    
    getName in interface DescriptionProvider
    
    Specified by:
    
    getName in interface NameProvider
    
    Returns:
    
    String
  - setName
```
public void setName(@NotNull
                    String name)
```
    Specified by:
    
    setName in interface Describable
  - getBuildName
```
@NotNull
public String getBuildName()
```
    Specified by:
    
    getBuildName in interface PlanIdentifier
    
    Returns:
    
    The plan specific portion of the name (without the project and/or parent's names). You probably want to use PlanIdentifier.getName()
  - setBuildName
```
public void setBuildName(String buildName)
```
    Specified by:
    
    setBuildName in interface Plan
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface DescriptionProvider
  - setDescription
```
public void setDescription(@Nullable
                           String description)
```
    Specified by:
    
    setDescription in interface Describable
  - getType
```
@NotNull
public String getType()
```
    Description copied from interface: ImmutablePlan
    
    Returns the string representation of the type. See PlanType and used in Freemarker.
    
    Specified by:
    
    getType in interface ImmutablePlan
    
    Returns:
    
    the string representation of the type
  - hasMaster
```
public boolean hasMaster()
```
    Specified by:
    
    hasMaster in interface ImmutablePlan
    
    Returns:
    
    true if plan has a master plan
  - isMarkedForDeletion
```
public boolean isMarkedForDeletion()
```
    Description copied from interface: ImmutablePlan
    
    Is the plan set to be deleted in the future
    
    Specified by:
    
    isMarkedForDeletion in interface ImmutableDeletable
    
    Specified by:
    
    isMarkedForDeletion in interface ImmutablePlan
    
    Returns:
    
    Whether or not the Object has been marked for deletion
  - setMarkedForDeletion
```
public void setMarkedForDeletion(boolean markedForDeletion)
```
    Specified by:
    
    setMarkedForDeletion in interface Deletable
  - setSuspendedFromBuilding
```
public void setSuspendedFromBuilding(boolean suspendedFromBuilding)
```
    Description copied from interface: Plan
    
    Sets the build to suspend temporarily
    
    Specified by:
    
    setSuspendedFromBuilding in interface Plan
  - isSuspendedFromBuilding
```
public boolean isSuspendedFromBuilding()
```
    Description copied from interface: PlanIdentifier
    
    Checks if the build has been enabled / disabled.
    
    Specified by:
    
    isSuspendedFromBuilding in interface PlanIdentifier
    
    Returns:
    
    true if plan is disabled
  - isBusy
```
public boolean isBusy()
```
    Description copied from interface: ImmutablePlan
    
    Is the Plan "busy". Busy is defined by the plan having a lock held on it. This is done during change detection, dependency listner and the like
    
    Specified by:
    
    isBusy in interface ImmutablePlan
    
    Returns:
    
    busy
  - getBuildLogger
```
@NotNull
public BuildLogger getBuildLogger()
```
    Description copied from interface: ImmutablePlan
    
    Returns the helper object to deal with logging
    
    Specified by:
    
    getBuildLogger in interface ImmutablePlan
    
    Returns:
    
    A BuildLogger.
  - getLastBuildNumber
```
public int getLastBuildNumber()
```
    Description copied from interface: ImmutablePlan
    
    What was the number of the latest build (may be being built)
    
    Specified by:
    
    getLastBuildNumber in interface ImmutablePlan
    
    Returns:
    
    the build number, zero if the build has not been built
  - getFirstBuildNumber
```
public int getFirstBuildNumber()
```
    Description copied from interface: ImmutablePlan
    
    What the number of the first build we have? It may not be 1 as some may have been removed!
    
    Specified by:
    
    getFirstBuildNumber in interface ImmutablePlan
    
    Returns:
    
    The number of the first build
  - getTestClasses
```
@NotNull
 @Deprecated
public List<TestClass> getTestClasses()
```
    Deprecated. since 6.9 used to be used for persistence
  - setTestClasses
```
@Deprecated
public void setTestClasses(List<TestClass> testCases)
```
    Deprecated. since 6.9 used to be used for persistence
  - getLatestResultsSummary
```
@Nullable
public ResultsSummary getLatestResultsSummary()
```
    Description copied from interface: ImmutablePlan
    
    Get the latest finished result
    
    Specified by:
    
    getLatestResultsSummary in interface ImmutablePlan
    
    Specified by:
    
    getLatestResultsSummary in interface Plan
    
    Returns:
    
    The summary info for the last completed build. Returns null if there are no build results for this plan
  - getVariables
```
@NotNull
public List<VariableDefinition> getVariables()
```
    Description copied from interface: ImmutablePlan
    
    Return list of VariableDefinitions bind to this Plan
    
    Specified by:
    
    getVariables in interface ImmutablePlan
    
    Returns:
    
    non-null list of VariableDefinition
  - getEffectiveVariables
```
@NotNull
public List<VariableDefinition> getEffectiveVariables()
```
    Description copied from interface: ImmutablePlan
    
    Return effective list of VariableDefinitions bind to this Plan. For master Plans this will return the same result as ImmutablePlan.getVariables(). Non-master plans will produce the sum of: - all master's variables which keys do not appear in result of ImmutablePlan.getVariables() - result of ImmutablePlan.getVariables()
    
    Specified by:
    
    getEffectiveVariables in interface ImmutablePlan
    
    Returns:
    
    non-null list of VariableDefinition
  - setProject
```
public void setProject(Project project)
```
    Specified by:
    
    setProject in interface Plan
  - getBuildDefinition
```
@NotNull
public BuildDefinition getBuildDefinition()
```
    Description copied from interface: ImmutablePlan
    
    Returns the BuildDefinition that backs this Plan
    
    Specified by:
    
    getBuildDefinition in interface ImmutablePlan
    
    Returns:
    
    BuildDefinition object.
  - getProject
```
@NotNull
public Project getProject()
```
    Description copied from interface: ImmutablePlan
    
    Returns the parent Project
    
    Specified by:
    
    getProject in interface ImmutablePlan
    
    Specified by:
    
    getProject in interface PlanIdentifier
    
    Returns:
    
    Project. Never null
  - getMasterId
```
public long getMasterId()
```
    Specified by:
    
    getMasterId in interface PlanIdentifier
    
    Returns:
    
    database id of master of this Plan or -1 if none.
  - getMasterIdIfExists
```
@NotNull
public Optional<Long> getMasterIdIfExists()
```
    Specified by:
    
    getMasterIdIfExists in interface PlanIdentifier
    
    Returns:
    
    database id of master of this Plan or empty if none.
  - getBuildDefinitionXml
```
@Nullable
public BuildDefinitionForBuild getBuildDefinitionXml()
```
    Specified by:
    
    getBuildDefinitionXml in interface Plan
  - setBuildDefinitionXml
```
public void setBuildDefinitionXml(@Nullable
                                  BuildDefinitionForBuild buildDefinitionXml)
```
    Specified by:
    
    setBuildDefinitionXml in interface Plan
  - getLabellings
```
@NotNull
public List<Labelling> getLabellings()
```
    Description copied from interface: Plan
    
    Used only for Hibernate mapping purposes. Deprecated for removal from the interface
    
    Specified by:
    
    getLabellings in interface Plan
    
    Returns:
  - getRelatedLabellings
```
@NotNull
public List<Labelling> getRelatedLabellings()
```
    Description copied from interface: Plan
    
    Returns labellings that are applicable for the plan level
    
    Specified by:
    
    getRelatedLabellings in interface Plan
    
    Returns:
    
    Empty list if no labels
  - getLabelNames
```
@NotNull
public List<String> getLabelNames()
```
    Specified by:
    
    getLabelNames in interface ImmutablePlan
    
    Returns:
    
    all the names of related labels with a namespace of :label
  - setLabellings
```
public void setLabellings(List<Labelling> labellings)
```
    Specified by:
    
    setLabellings in interface Plan
  - setPlanExecutionManager
```
public void setPlanExecutionManager(PlanExecutionManager planExecutionManager)
```
  - setBuildDefinitionManager
```
public void setBuildDefinitionManager(BuildDefinitionManager buildDefinitionManager)
```
  - setBuildLoggerManager
```
public void setBuildLoggerManager(BuildLoggerManager buildLoggerManager)
```
  - setResultsSummaryManager
```
public void setResultsSummaryManager(ResultsSummaryManager resultsSummaryManager)
```
  - setVariableDefinitionManager
```
public void setVariableDefinitionManager(VariableDefinitionManager variableDefinitionManager)
```
  - setLabelManager
```
public void setLabelManager(LabelManager labelManager)
```
  - getDiscriminator
```
public String getDiscriminator()
```
  - setDiscriminator
```
public void setDiscriminator(String discriminator)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class com.atlassian.core.bean.EntityObject
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class com.atlassian.core.bean.EntityObject
  - compareTo
```
public int compareTo(Plan plan)
```
    Specified by:
    
    compareTo in interface Comparable<Plan>

Class AbstractPlan

Field Summary

Fields inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlan

Fields inherited from interface com.atlassian.bamboo.plan.PlanIdentifier

Fields inherited from interface com.atlassian.bamboo.plan.PlanKeyProvider

Constructor Summary

Method Summary

Methods inherited from class com.atlassian.bamboo.hibernate.HibernateBambooEntityWithOid

Methods inherited from class com.atlassian.core.bean.EntityObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.bamboo.plan.Plan

Methods inherited from interface com.atlassian.bamboo.core.EntityWithOid

Methods inherited from interface com.atlassian.bamboo.core.ImmutableEntityWithOid

Methods inherited from interface com.atlassian.bamboo.core.BambooObject

Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlan

Methods inherited from interface com.atlassian.bamboo.plan.PlanIdentifier

Field Detail

resultsSummaryManager

Constructor Detail

AbstractPlan

Method Detail

getDatabaseId

getPlanKey

getKey

setKey

setPlanKey

getBuildKey

setBuildKey

getName

setName

getBuildName

setBuildName

getDescription

setDescription

getType

hasMaster

isMarkedForDeletion

setMarkedForDeletion

setSuspendedFromBuilding

isSuspendedFromBuilding

isBusy

getBuildLogger

getLastBuildNumber

getFirstBuildNumber

getTestClasses

setTestClasses

getLatestResultsSummary

getVariables

getEffectiveVariables

setProject

getBuildDefinition

getProject

getMasterId

getMasterIdIfExists

getBuildDefinitionXml

setBuildDefinitionXml

getLabellings

getRelatedLabellings

getLabelNames

setLabellings

setPlanExecutionManager

setBuildDefinitionManager

setBuildLoggerManager

setResultsSummaryManager

setVariableDefinitionManager

setLabelManager

getDiscriminator

setDiscriminator

hashCode

equals

compareTo