com.atlassian.bamboo.plan
Class PlanPermissionSkeleton

java.lang.Object
  extended by com.atlassian.bamboo.plan.PlanPermissionSkeleton
All Implemented Interfaces:
BambooIdProvider, BambooObject, Deletable, Describable, ImmutableDeletable, ImmutablePlan, Plan, PlanIdentifier, DescriptionProvider, NameProvider

Deprecated. since 4.2 use @{link PlanHelper.getPlanIdentifierForPermissionChecking}

@Deprecated
public class PlanPermissionSkeleton
extends java.lang.Object
implements Plan


Field Summary
 
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
 
Constructor Summary
PlanPermissionSkeleton(long id, java.lang.String planKey, java.lang.Class<? extends Plan> planClass, PlanType planType)
          Deprecated.  
 
Method Summary
 long getAverageBuildDuration()
          Deprecated. Returns an average duration of the recent builds
 BuildDefinition getBuildDefinition()
          Deprecated. Returns the BuildDefinition that backs this Plan
 BuildDefinitionForBuild getBuildDefinitionXml()
          Deprecated.  
 java.lang.String getBuildKey()
          Deprecated. This objects specific portion of the key.
 BuildLogger getBuildLogger()
          Deprecated. Returns the helper object to deal with logging
 java.lang.String getBuildName()
          Deprecated.  
 java.lang.String getCurrentStatus()
          Deprecated. Retuns a string key as to what the status is.
 java.lang.String getDescription()
          Deprecated.  
 java.util.List<VariableDefinition> getEffectiveVariables()
          Deprecated. Return effective list of VariableDefinitions bind to this Plan.
 int getFirstBuildNumber()
          Deprecated. What the number of the first build we have? It may not be 1 as some may have been removed!
 long getId()
          Deprecated.  
 java.lang.String getKey()
          Deprecated. Obtain the plan's unique key (uppercase alphanumeric).
 java.util.List<Labelling> getLabellings()
          Deprecated. Used only for Hibernate mapping purposes.
 java.util.List<java.lang.String> getLabelNames()
          Deprecated. Returns all the names of related labels with a namesapce of :label
 int getLastBuildNumber()
          Deprecated. What was the number of the latest build (may be being built)
 ResultsSummary getLatestResultsSummary()
          Deprecated. Get the latest finished result
 Plan getMaster()
          Deprecated. Return the master plan if one exists.
 long getMasterId()
          Deprecated. Database id of master of this ChainBranch
 java.lang.String getName()
          Deprecated. Returns the full name for the build in the form of "project name - build name" e.g.
 int getNextBuildNumber()
          Deprecated. The next build number represents the number of the next build result that's to be executed
 java.lang.Class<? extends Plan> getPlanClass()
          Deprecated.  
 PlanKey getPlanKey()
          Deprecated. Get the PlanKey identifier for this Plan
 PlanType getPlanType()
          Deprecated.  
 Project getProject()
          Deprecated. Returns the parent Project
 java.util.List<Labelling> getRelatedLabellings()
          Deprecated. Returns labellings that's application for the plan level
 java.lang.String getType()
          Deprecated. Returns the string representation of the type.
 java.util.List<VariableDefinition> getVariables()
          Deprecated. Return list of VariableDefinitions bind to this Plan
 boolean hasMaster()
          Deprecated.  
 boolean isActive()
          Deprecated. Is the plan queued or building?
 boolean isBusy()
          Deprecated. Is the Plan "busy".
 boolean isExecuting()
          Deprecated. Is the build currently being executed?
 boolean isMarkedForDeletion()
          Deprecated. Is the plan set to be deleted in the future
 boolean isSuspendedFromBuilding()
          Deprecated. Checks if the build has been enabled / disabled.
 void setBuildDefinitionXml(BuildDefinitionForBuild buildDefinitionXml)
          Deprecated.  
 void setBuildKey(java.lang.String buildKey)
          Deprecated. Define the build's unique key (uppercase alphanumeric)
 void setBuildName(java.lang.String buildName)
          Deprecated.  
 void setDescription(java.lang.String description)
          Deprecated.  
 void setFirstBuildNumber(int firstBuildNumber)
          Deprecated.  
 void setId(long id)
          Deprecated.  
 void setKey(java.lang.String fullKey)
          Deprecated.  
 void setLabellings(java.util.List<Labelling> labellings)
          Deprecated.  
 void setLastBuildNumber(int lastBuildNumber)
          Deprecated.  
 void setMarkedForDeletion(boolean markedForDeletion)
          Deprecated.  
 void setMaster(Plan master)
          Deprecated. Set which plan is the master of this plan.
 void setName(java.lang.String name)
          Deprecated.  
 void setNextBuildNumber(int nextBuildNumber)
          Deprecated.  
 void setPlanKey(PlanKey fullKey)
          Deprecated.  
 void setProject(Project project)
          Deprecated.  
 void setSuspendedFromBuilding(boolean suspendFromBuilding)
          Deprecated. Sets the build to suspend temporarily
 ErrorCollection validateBuild()
          Deprecated. Validates the build's builder and source code locations
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PlanPermissionSkeleton

public PlanPermissionSkeleton(long id,
                              java.lang.String planKey,
                              java.lang.Class<? extends Plan> planClass,
                              PlanType planType)
Deprecated. 
Method Detail

getId

public long getId()
Deprecated. 
Specified by:
getId in interface BambooIdProvider
Specified by:
getId in interface PlanIdentifier
Returns:
Database id of the plan

setId

public void setId(long id)
Deprecated. 
Specified by:
setId in interface BambooObject

getPlanKey

@NotNull
public PlanKey getPlanKey()
Deprecated. 
Description copied from interface: PlanIdentifier
Get the PlanKey identifier for this Plan

Specified by:
getPlanKey in interface PlanIdentifier
Returns:
planKey

getKey

@NotNull
public java.lang.String getKey()
Deprecated. 
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

getPlanClass

public java.lang.Class<? extends Plan> getPlanClass()
Deprecated. 

getPlanType

@NotNull
public PlanType getPlanType()
Deprecated. 
Specified by:
getPlanType in interface PlanIdentifier
Returns:
the type of this plan

setKey

public void setKey(java.lang.String fullKey)
Deprecated. 
Specified by:
setKey in interface Plan

setPlanKey

public void setPlanKey(@NotNull
                       PlanKey fullKey)
Deprecated. 
Specified by:
setPlanKey in interface Plan

getBuildKey

@NotNull
public java.lang.String getBuildKey()
Deprecated. 
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(java.lang.String buildKey)
Deprecated. 
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 java.lang.String getName()
Deprecated. 
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

getDescription

public java.lang.String getDescription()
Deprecated. 
Specified by:
getDescription in interface DescriptionProvider

getBuildName

@NotNull
public java.lang.String getBuildName()
Deprecated. 
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(java.lang.String buildName)
Deprecated. 
Specified by:
setBuildName in interface Plan

setMaster

public void setMaster(Plan master)
Deprecated. 
Description copied from interface: Plan
Set which plan is the master of this plan. The master is the plan which this one is derived from. Configuration is pulled from the master if one exists.

Specified by:
setMaster in interface Plan

getMaster

public Plan getMaster()
Deprecated. 
Description copied from interface: ImmutablePlan
Return the master plan if one exists. The master is the plan which this one is derived from. Configuration is pulled from the master if one exists.

Specified by:
getMaster in interface ImmutablePlan
Returns:
the master Plan if one exists.

hasMaster

public boolean hasMaster()
Deprecated. 
Specified by:
hasMaster in interface ImmutablePlan
Returns:
true if plan has a master plan

validateBuild

public ErrorCollection validateBuild()
Deprecated. 
Description copied from interface: Plan
Validates the build's builder and source code locations

Specified by:
validateBuild in interface Plan
Returns:
and ErrorCollection with relevent error messages

getCurrentStatus

@NotNull
public java.lang.String getCurrentStatus()
Deprecated. 
Description copied from interface: ImmutablePlan
Retuns a string key as to what the status is. Can be "success", "failure", "current", "none" or "notRun". Mainly used for UI purposes.

Specified by:
getCurrentStatus in interface ImmutablePlan
Returns:

isExecuting

public boolean isExecuting()
Deprecated. 
Description copied from interface: ImmutablePlan
Is the build currently being executed?

Specified by:
isExecuting in interface ImmutablePlan
Returns:
true if build is being executed

setSuspendedFromBuilding

public void setSuspendedFromBuilding(boolean suspendFromBuilding)
Deprecated. 
Description copied from interface: Plan
Sets the build to suspend temporarily

Specified by:
setSuspendedFromBuilding in interface Plan

isSuspendedFromBuilding

public boolean isSuspendedFromBuilding()
Deprecated. 
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

getLastBuildNumber

public int getLastBuildNumber()
Deprecated. 
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()
Deprecated. 
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

getBuildDefinition

@NotNull
public BuildDefinition getBuildDefinition()
Deprecated. 
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()
Deprecated. 
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

setProject

public void setProject(Project project)
Deprecated. 
Specified by:
setProject in interface Plan

getNextBuildNumber

public int getNextBuildNumber()
Deprecated. 
Description copied from interface: ImmutablePlan
The next build number represents the number of the next build result that's to be executed

Specified by:
getNextBuildNumber in interface ImmutablePlan
Returns:
a build number, starting with 1

setNextBuildNumber

public void setNextBuildNumber(int nextBuildNumber)
Deprecated. 
Specified by:
setNextBuildNumber in interface Plan

setLastBuildNumber

public void setLastBuildNumber(int lastBuildNumber)
Deprecated. 
Specified by:
setLastBuildNumber in interface Plan

setFirstBuildNumber

public void setFirstBuildNumber(int firstBuildNumber)
Deprecated. 
Specified by:
setFirstBuildNumber in interface Plan

getBuildDefinitionXml

public BuildDefinitionForBuild getBuildDefinitionXml()
Deprecated. 
Specified by:
getBuildDefinitionXml in interface Plan

setBuildDefinitionXml

public void setBuildDefinitionXml(BuildDefinitionForBuild buildDefinitionXml)
Deprecated. 
Specified by:
setBuildDefinitionXml in interface Plan

getLabellings

@NotNull
public java.util.List<Labelling> getLabellings()
Deprecated. 
Description copied from interface: Plan
Used only for Hibernate mapping purposes. Deprecated for removal from the interface

Specified by:
getLabellings in interface Plan
Returns:

setLabellings

public void setLabellings(java.util.List<Labelling> labellings)
Deprecated. 
Specified by:
setLabellings in interface Plan

getRelatedLabellings

@NotNull
public java.util.List<Labelling> getRelatedLabellings()
Deprecated. 
Description copied from interface: Plan
Returns labellings that's application for the plan level

Specified by:
getRelatedLabellings in interface Plan
Returns:
Empty list if no labels

getBuildLogger

@NotNull
public BuildLogger getBuildLogger()
Deprecated. 
Description copied from interface: ImmutablePlan
Returns the helper object to deal with logging

Specified by:
getBuildLogger in interface ImmutablePlan
Returns:
A BuildLogger. @NotNull

isActive

public boolean isActive()
Deprecated. 
Description copied from interface: ImmutablePlan
Is the plan queued or building?

Specified by:
isActive in interface ImmutablePlan
Returns:

getAverageBuildDuration

public long getAverageBuildDuration()
Deprecated. 
Description copied from interface: ImmutablePlan
Returns an average duration of the recent builds

Specified by:
getAverageBuildDuration in interface ImmutablePlan
Returns:
The duration in milliseconds

getType

@NotNull
public java.lang.String getType()
Deprecated. 
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

getLatestResultsSummary

public ResultsSummary getLatestResultsSummary()
Deprecated. 
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

isBusy

public boolean isBusy()
Deprecated. 
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

getLabelNames

@NotNull
public java.util.List<java.lang.String> getLabelNames()
Deprecated. 
Description copied from interface: ImmutablePlan
Returns all the names of related labels with a namesapce of :label

Specified by:
getLabelNames in interface ImmutablePlan
Returns:

isMarkedForDeletion

public boolean isMarkedForDeletion()
Deprecated. 
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)
Deprecated. 
Specified by:
setMarkedForDeletion in interface Deletable

setName

public void setName(@NotNull
                    java.lang.String name)
Deprecated. 
Specified by:
setName in interface Describable

setDescription

public void setDescription(@Nullable
                           java.lang.String description)
Deprecated. 
Specified by:
setDescription in interface Describable

getVariables

@NotNull
public java.util.List<VariableDefinition> getVariables()
Deprecated. 
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 java.util.List<VariableDefinition> getEffectiveVariables()
Deprecated. 
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

getMasterId

public long getMasterId()
Deprecated. 
Description copied from interface: PlanIdentifier
Database id of master of this ChainBranch

Specified by:
getMasterId in interface PlanIdentifier
Returns:


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.