jetbrains.buildServer.vcs
Interface SVcsRoot

All Superinterfaces:

VcsRoot

public interface SVcsRoot
extends VcsRoot

Server side class for the vcs root.

Field Summary

Fields inherited from interface jetbrains.buildServer.vcs.VcsRoot

SECURE_PROPERTY_PREFIX

Method Summary

void	checkAccessibleFrom(SBuildType buildType) Checks that VCS root with this scope is accessible from the specified build configuration
java.lang.String	getDescription()
int	getModificationCheckInterval() returns modification check interval in seconds
VcsRootScope	getScope() Returns scope of this VCS root
java.lang.String	getVcsDisplayName() Returns VCS plugin display name
boolean	isAccessibleFrom(SBuildType buildType) Returns true if VCS roots with this scope are accessible from the specified build configuration.
boolean	isUseDefaultModificationCheckInterval() Returns if 'use default modification check interval' mode is enabled for the root.
void	restoreDefaultModificationCheckInterval() Switched to 'use default modification check interval' mode.
void	setModificationCheckInterval(int value) Changes modification check interval for the root.

Methods inherited from interface jetbrains.buildServer.vcs.VcsRoot

convertToPresentableString, convertToString, createSecureCopy, getId, getName, getProperties, getPropertiesHash, getProperty, getProperty, getRootVersion, getVcsName

Method Detail

getScope

VcsRootScope getScope()

Returns scope of this VCS root

Returns:

scope of this VCS root

getModificationCheckInterval

int getModificationCheckInterval()

returns modification check interval in seconds

Returns:

modification check interval configured for the root.

setModificationCheckInterval

void setModificationCheckInterval(int value)

Changes modification check interval for the root.

Parameters:

value - seconds.

isUseDefaultModificationCheckInterval

boolean isUseDefaultModificationCheckInterval()

Returns if 'use default modification check interval' mode is enabled for the root.

Returns:

if 'use default modification check interval' mode is enabled for the root.

restoreDefaultModificationCheckInterval

void restoreDefaultModificationCheckInterval()

Switched to 'use default modification check interval' mode.

isAccessibleFrom

boolean isAccessibleFrom(@NotNull
                         SBuildType buildType)

Returns true if VCS roots with this scope are accessible from the specified build configuration.

Parameters:

buildType - build configuration

Returns:

true if VCS roots with this scope are accessible from the specified build configuration.

checkAccessibleFrom

void checkAccessibleFrom(@NotNull
                         SBuildType buildType)
                         throws InvalidVcsRootScopeException

Checks that VCS root with this scope is accessible from the specified build configuration

Parameters:

buildType - build configuration

Throws:

InvalidVcsRootScopeException - if VCS root is inaccessible

getDescription

@NotNull
java.lang.String getDescription()

Returns:

short human readable description of the root. Composed by underlying VCS support.

Since:

4.5

getVcsDisplayName

@Nullable
java.lang.String getVcsDisplayName()

Returns VCS plugin display name

Returns:

see above, returns null if VCS plugin corresponding to VCS root does not exist

Since:

4.5