jetbrains.buildServer.serverSide
Interface BuildTypeTemplate

All Superinterfaces:

BuildTypeOptions, BuildTypeSettings, java.lang.Comparable<BuildTypeTemplate>, CompatibleAgents, DependencySettings, OptionSupport, ParametersSupport, ReadOnlyUserParameters, UserParametersHolder, VcsLabelingSettings, XmlExternalizable

public interface BuildTypeTemplate
extends BuildTypeSettings, CompatibleAgents, java.lang.Comparable<BuildTypeTemplate>, ParametersSupport

Build configuration template. Contains settings of build configuration.

Since:

5.0

Nested Class Summary

Nested classes/interfaces inherited from interface jetbrains.buildServer.serverSide.vcs.VcsLabelingSettings

VcsLabelingSettings.LabelingType

Field Summary

Fields inherited from interface jetbrains.buildServer.serverSide.BuildTypeOptions

BT_ALLOW_EXTERNAL_STATUS, BT_BUILD_NUMBER_PATTERN, BT_CLEAN_BUILD, BT_EXECUTION_TIMEOUT, BT_FAIL_IF_TESTS_FAIL, BT_FAIL_ON_ANY_ERROR_MESSAGE, BT_FAIL_ON_EXIT_CODE, BT_FAIL_ON_OOME_OR_CRASH, BT_HANGING_BUILDS_DETECTION_ENABLED, BT_MAX_RUNNING_BUILDS, BT_SHOW_DEPS_CHANGES, DEFAULT_BUILD_NUMBER_PATTERN

Fields inherited from interface jetbrains.buildServer.serverSide.vcs.VcsLabelingSettings

DEFAULT_LABEL_PATTERN

Method Summary

void	applyRunnersOrder(java.lang.String[] ids) Changes order of build runners in this template and in all of the inherited build configurations.
java.lang.String	getFullName() Returns full name of this template (including project name)
java.lang.String	getId() Returns id of this template
java.lang.String	getName() Returns template name
int	getNumberOfUsages() Returns total number of this template usages (without permissions filtering)
SProject	getParentProject() Returns project to which this template belongs
java.lang.String	getParentProjectId() Returns id of the project to which this template belongs
java.util.Collection<SBuildType>	getUsages() Returns collection of build configurations using this template.
boolean	isCanAttachLocalVcsRoot() Returns true if project local (non-shared) VCS root can be attached to this template
void	moveToProject(SProject target) Moves this template to the specified project.
void	persist() Persist this template settings, should be called after settings modifications to preserve template state.
void	setName(java.lang.String name) Sets name of the template

Methods inherited from interface jetbrains.buildServer.serverSide.BuildTypeSettings

addBuildFeature, addBuildFeature, addBuildParameter, addBuildRunner, addBuildRunner, addBuildTrigger, addBuildTrigger, addConfigParameter, addRequirement, addRunParameter, addVcsRoot, clearRunParameters, containsVcsRoot, findBuildRunnerById, findBuildRunnerByType, findRunnerParameter, findTriggerById, getArtifactDependencies, getArtifactPaths, getBuildFeatures, getBuildNumberPattern, getBuildParameter, getBuildParameters, getBuildParametersCollection, getBuildRunner, getBuildRunners, getBuildTriggersCollection, getCheckoutDirectory, getCheckoutRules, getCheckoutType, getConfigParameters, getConfigParametersCollection, getImplicitRequirements, getRequirements, getRunnerTypes, getRunParameter, getRunParameters, getRunParametersCollection, getRunType, getRunTypeRequirements, getTemplate, getTemplateId, getUndefinedParameters, getVcsRootEntries, getVcsRoots, isEnabled, isTemplateBased, removeAllBuildRunners, removeBuildFeature, removeBuildParameter, removeBuildRunner, removeBuildTrigger, removeConfigParameter, removeRequirement, removeVcsRoot, replaceInValues, setArtifactDependencies, setArtifactPaths, setBuildNumberPattern, setCheckoutDirectory, setCheckoutRules, setCheckoutType, setEnabled, setRunType, updateBuildFeature, updateBuildRunner, updateBuildTrigger

Methods inherited from interface jetbrains.buildServer.util.OptionSupport

getChangedOptions, getOption, setOption

Methods inherited from interface jetbrains.buildServer.serverSide.UserParametersHolder

addParameter, getParameters, getParametersCollection, removeParameter

Methods inherited from interface jetbrains.buildServer.serverSide.dependency.DependencySettings

addDependency, getDependencies, removeDependency

Methods inherited from interface jetbrains.buildServer.serverSide.vcs.VcsLabelingSettings

getLabelingRoots, getLabelingType, getLabelPattern, setLabelingRoots, setLabelingType, setLabelPattern

Methods inherited from interface jetbrains.buildServer.serverSide.CompatibleAgents

getAgentCompatibility, getCompatibilityMap, getCompatibleAgents

Methods inherited from interface jetbrains.buildServer.XmlExternalizable

writeTo

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface jetbrains.buildServer.serverSide.ParametersSupport

getParametersProvider, getValueResolver

Method Detail

getId

@NotNull
java.lang.String getId()

Returns id of this template

Returns:

id of template

getName

@NotNull
java.lang.String getName()

Returns template name

Returns:

template name

getFullName

@NotNull
java.lang.String getFullName()

Returns full name of this template (including project name)

Returns:

see above

setName

void setName(@NotNull
             java.lang.String name)

Sets name of the template

Parameters:

name - template name

persist

void persist()

Persist this template settings, should be called after settings modifications to preserve template state.

Specified by:

persist in interface BuildTypeSettings

getUsages

java.util.Collection<SBuildType> getUsages()

Returns collection of build configurations using this template.

Returns:

see above.

getNumberOfUsages

int getNumberOfUsages()

Returns total number of this template usages (without permissions filtering)

Returns:

see above

getParentProject

@NotNull
SProject getParentProject()

Returns project to which this template belongs

Returns:

see above

getParentProjectId

@NotNull
java.lang.String getParentProjectId()

Returns id of the project to which this template belongs

Returns:

see above

Since:

6.5

moveToProject

void moveToProject(@NotNull
                   SProject target)

Moves this template to the specified project. Note that if there are local VCS roots attached to this template, they will be shared. If sharing is impossible due to lack of access rights, AccessDeniedException will be thrown.

Parameters:

target - target project

isCanAttachLocalVcsRoot

boolean isCanAttachLocalVcsRoot()

Returns true if project local (non-shared) VCS root can be attached to this template

Returns:

see above

applyRunnersOrder

void applyRunnersOrder(@NotNull
                       java.lang.String[] ids)

Changes order of build runners in this template and in all of the inherited build configurations. Note that after that persist operation invoked on the template will also persist inherited build configurations.

Specified by:

applyRunnersOrder in interface BuildTypeSettings

Parameters:

ids - runner identifiers