Package jetbrains.buildServer.vcs

Interface SVcsRootUpdate

All Known Subinterfaces:

SVcsRoot, SVcsRootEx

All Known Implementing Classes:

DeletedVcsRoot, InaccessibleVcsRoot, MockSVcsRoot, SecuredVcsRoot, SVcsRootImpl

public interface SVcsRootUpdate

Created 22.08.13 17:18

Author:

Eugene Petrenko (eugene.petrenko@jetbrains.com)

Method Summary

Modifier and Type	Method	Description
void	moveToProject(ConfigAction cause, SProject target)	Moves this VCS root to specified target project.
void	moveToProject(SProject target)	Moves this VCS root to specified target project.
void	persist()	Persists this VCS root on disk
void	remove()	Removes this VCS root from it's project.
void	restoreDefaultModificationCheckInterval()	Switched to 'use default modification check interval' mode.
void	setExternalId(String externalId)	Changes external id of this VCS root and persists this VCS root configuration to disk
void	setExternalId(ConfigAction cause, String externalId)	Changes external id of this VCS root and persists this VCS root configuration to disk
void	setModificationCheckInterval(int value)	Changes modification check interval for the root.
void	setName(String newName)	Sets new name to this VCS root.
void	setProperties(Map<String,String> props)	Sets new properties to this VCS root.
void	setVcsName(String vcsName)	Sets name of version control to this VCS root.

Method Detail

setModificationCheckInterval

void setModificationCheckInterval(int value)
                           throws ReadOnlyEntityException

Changes modification check interval for the root.

Parameters:

value - seconds.

Throws:

ReadOnlyEntityException

restoreDefaultModificationCheckInterval

void restoreDefaultModificationCheckInterval()
                                      throws ReadOnlyEntityException

Switched to 'use default modification check interval' mode.

Throws:

ReadOnlyEntityException

setVcsName

void setVcsName(@NotNull
                String vcsName)
         throws ReadOnlyEntityException

Sets name of version control to this VCS root.

Parameters:

vcsName - name of version control

Throws:

ReadOnlyEntityException

Since:

8.0

setName

void setName(@NotNull
             String newName)
      throws DuplicateVcsRootNameException,
             InvalidNameException,
             ReadOnlyEntityException

Sets new name to this VCS root.

Parameters:

newName - new VCS root name

Throws:

DuplicateVcsRootNameException - if VCS root with such name already exists in VCS root project

InvalidNameException

ReadOnlyEntityException

Since:

8.0

setExternalId

void setExternalId(@NotNull
                   String externalId)
            throws DuplicateExternalIdException,
                   InvalidIdentifierException,
                   ObsoleteEntityException,
                   ReadOnlyEntityException

Changes external id of this VCS root and persists this VCS root configuration to disk

Parameters:

externalId - new external id

Throws:

DuplicateExternalIdException - if newly specified external id already exists

ObsoleteEntityException - when VCS root is not the same as the one in the project model (since 9.1.2)

InvalidIdentifierException

ReadOnlyEntityException

Since:

8.0

setExternalId

void setExternalId(@NotNull
                   ConfigAction cause,
                   @NotNull
                   String externalId)
            throws DuplicateExternalIdException,
                   InvalidIdentifierException,
                   ObsoleteEntityException,
                   ReadOnlyEntityException

Changes external id of this VCS root and persists this VCS root configuration to disk

Parameters:

cause - config action caused the change

externalId - new external id

Throws:

DuplicateExternalIdException - if newly specified external id already exists

ObsoleteEntityException - when VCS root is not the same as the one in the project model (since 9.1.2)

InvalidIdentifierException

ReadOnlyEntityException

Since:

9.0

setProperties

void setProperties(@NotNull
                   Map<String,String> props)
            throws ReadOnlyEntityException

Sets new properties to this VCS root.

Parameters:

props - new VCS root properties

Throws:

ReadOnlyEntityException

Since:

8.0

persist

void persist()
      throws ProjectNotFoundException

Persists this VCS root on disk

Throws:

ProjectNotFoundException - if project where this VCS root belongs does not exist

Since:

8.0

remove

void remove()
     throws VcsRootUsedException,
            ProjectNotFoundException,
            ReadOnlyEntityException

Removes this VCS root from it's project.

Throws:

VcsRootUsedException - if VCS root is used in some configuration or template and cannot be removed

ProjectNotFoundException - if project where this VCS root belongs does not exist

ReadOnlyEntityException

Since:

8.0

moveToProject

void moveToProject(@NotNull
                   SProject target)
            throws ScopeCannotBeChangedException,
                   DuplicateVcsRootNameException,
                   ReadOnlyEntityException

Moves this VCS root to specified target project. Upon successful completion affected configuration settings will be persisted.

Parameters:

target - target project

Throws:

ScopeCannotBeChangedException - if move is impossible because of VCS root usages

ReadOnlyEntityException - if target project is read only

DuplicateVcsRootNameException

Since:

8.0

moveToProject

void moveToProject(@NotNull
                   ConfigAction cause,
                   @NotNull
                   SProject target)
            throws ScopeCannotBeChangedException,
                   DuplicateVcsRootNameException,
                   ReadOnlyEntityException

Moves this VCS root to specified target project. Upon successful completion affected configuration settings will be persisted.

Parameters:

cause - config action caused the change

target - target project

Throws:

ScopeCannotBeChangedException - if move is impossible because of VCS root usages

DuplicateExternalIdException - if newly specified external id already exists

ReadOnlyEntityException - if target project is read only

DuplicateVcsRootNameException

Since:

9.0