|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Plan
Field Summary | |
---|---|
static int |
MAX_NUMBER_LOG_ENTRIES
|
static int |
MAX_PREVIOUS_BUILD_FOR_AVE
|
static java.lang.String |
STATUS_CURRENTLY_BUILDING
|
static java.lang.String |
STATUS_FAIL
|
static java.lang.String |
STATUS_NO_BUILDS
|
static java.lang.String |
STATUS_NOT_RUN
|
static java.lang.String |
STATUS_SUCCESS
|
Method Summary | |
---|---|
void |
accept(PlanVisitor planVisitor)
|
BuildDefinition |
getBuildDefinition()
Returns the BuildDefinition that backs this buildd |
BuildDefinitionForBuild |
getBuildDefinitionXml()
|
java.lang.String |
getBuildKey()
Thie returns the build portion of the build key |
BuildLogger |
getBuildLogger()
Returns the helper object to deal with logging |
java.lang.String |
getBuildName()
Returns the name for the build in the form of "build name" e.g. |
java.lang.String |
getCurrentStatus()
Retuns a string key as to what the status is. |
int |
getFirstBuildNumber()
What the number of the first build we have? It may not be 1 as some may have been removed! |
java.lang.String |
getKey()
Obtain the build's unique key (uppercase alphanumeric). |
java.util.List<Labelling> |
getLabellings()
|
int |
getLastBuildNumber()
What was the number of the lastest build (may be being built) |
java.lang.String |
getLastVcsRevisionKey()
The string value representing the last build triggered. |
java.lang.String |
getName()
Returns the full name for the build in the form of "projet name - build name" e.g. |
int |
getNextBuildNumber()
The next build number represents the number of the next build result that's to be executed |
NotificationSet |
getNotificationSet()
|
PlanKey |
getPlanKey()
Get the PlanKey identifier for this Plan |
Project |
getProject()
Returns the parent Project |
java.util.List<Labelling> |
getRelatedLabellings()
|
RequirementSet |
getRequirementSet()
|
java.io.File |
getSourceCodeDirectory()
Returns a file representing the source directory from the Repository |
boolean |
isExecuting()
Is the build currenlty being executed? |
boolean |
isInBuildQueue()
Is the build currenlty being built? |
boolean |
isMarkedForDeletion()
Whether or not the build has been marked for deletion |
boolean |
isSuspendedFromBuilding()
Checks if the build has been |
void |
markForDeletion()
Marks the build to be deleted. |
void |
setBuildDefinitionXml(BuildDefinitionForBuild buildDefinitionXml)
|
void |
setBuildKey(java.lang.String buildKey)
Define the build's unique key (uppercase alphanumeric) |
void |
setBuildName(java.lang.String buildName)
|
void |
setFirstBuildNumber(int firstBuildNumber)
|
void |
setKey(java.lang.String fullKey)
|
void |
setLabellings(java.util.List<Labelling> labellings)
|
void |
setLastBuildNumber(int lastBuildNumber)
|
void |
setLastVcsRevisionKey(java.lang.String lastVcsRevisionKey)
|
void |
setNextBuildNumber(int nextBuildNumber)
|
void |
setNotificationSet(NotificationSet notificationSet)
|
void |
setProject(Project project)
|
void |
setRequirementSet(RequirementSet requirementSet)
|
void |
setSuspendedFromBuilding(boolean suspendFromBuilding)
Sets the build to suspend temporarily |
void |
unMarkForDeletion()
Build will no longer be marked for deletion |
ErrorCollection |
validateBuild()
Validates the build's builder and source code locations |
Methods inherited from interface com.atlassian.bamboo.core.BambooObject |
---|
getId, setId |
Methods inherited from interface com.atlassian.bamboo.Describable |
---|
setDescription, setName |
Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider |
---|
getDescription |
Field Detail |
---|
static final int MAX_NUMBER_LOG_ENTRIES
static final int MAX_PREVIOUS_BUILD_FOR_AVE
static final java.lang.String STATUS_FAIL
static final java.lang.String STATUS_SUCCESS
static final java.lang.String STATUS_CURRENTLY_BUILDING
static final java.lang.String STATUS_NO_BUILDS
static final java.lang.String STATUS_NOT_RUN
Method Detail |
---|
@NotNull PlanKey getPlanKey()
PlanKey
identifier for this Plan
java.lang.String getKey()
void setKey(java.lang.String fullKey)
java.lang.String getBuildKey()
void setBuildKey(java.lang.String buildKey)
buildKey
- The value of the key@NotNull java.lang.String getName()
getName
in interface DescriptionProvider
getName
in interface NameProvider
java.lang.String getBuildName()
void setBuildName(java.lang.String buildName)
ErrorCollection validateBuild()
ErrorCollection
with relevent error messagesjava.lang.String getCurrentStatus()
java.io.File getSourceCodeDirectory() throws RepositoryException
Repository
RepositoryException
boolean isExecuting()
void markForDeletion()
void unMarkForDeletion()
boolean isMarkedForDeletion()
void setSuspendedFromBuilding(boolean suspendFromBuilding)
suspendFromBuilding
- boolean isSuspendedFromBuilding()
int getLastBuildNumber()
int getFirstBuildNumber()
BuildDefinition getBuildDefinition()
BuildDefinition
that backs this buildd
BuildDefinition
object. Never null.Project getProject()
Project
Project
. Never nullvoid setProject(Project project)
int getNextBuildNumber()
void setNextBuildNumber(int nextBuildNumber)
void setLastBuildNumber(int lastBuildNumber)
void setFirstBuildNumber(int firstBuildNumber)
BuildDefinitionForBuild getBuildDefinitionXml()
void setBuildDefinitionXml(BuildDefinitionForBuild buildDefinitionXml)
java.util.List<Labelling> getLabellings()
void setLabellings(java.util.List<Labelling> labellings)
java.util.List<Labelling> getRelatedLabellings()
NotificationSet getNotificationSet()
void setNotificationSet(NotificationSet notificationSet)
BuildLogger getBuildLogger()
BuildLogger
. @NotNull@Nullable java.lang.String getLastVcsRevisionKey()
void setLastVcsRevisionKey(java.lang.String lastVcsRevisionKey)
@NotNull RequirementSet getRequirementSet()
void setRequirementSet(RequirementSet requirementSet)
boolean isInBuildQueue()
void accept(PlanVisitor planVisitor)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |