Package jetbrains.buildServer.serverSide

Interface BuildTypeIdentity

All Superinterfaces:

SPersistentEntity

All Known Subinterfaces:

BuildTypeEx, BuildTypeIdentityEx, BuildTypeTemplate, BuildTypeTemplateEx, RemoteBuildType, RemoteBuildTypeEx, SBuildType

All Known Implementing Classes:

BaseBuildTypeIdentity, BuildTypeImpl, BuildTypeTemplateImpl, DummyBuildType, EditableBuildTypeCopy, EditableTemplateCopy, InaccessibleTemplate, MockBuildType, RemoteBuildTypeImpl, SecuredBuildType, SecuredBuildTypeTemplate

public interface BuildTypeIdentity
extends SPersistentEntity

Base interface for build template and build configurations, containing only identifiers and related things. Doesn't contain build settings.

Since:

8.0

Author:

Leonid Bushuev from JetBrains

Method Summary

Modifier and Type	Method	Description
boolean	belongsTo(SProject project)	Checks whether this build type or template belongs to the specified project or one of its subprojects, transitively.
File	getConfigurationFile()	Returns the configuration file where this build type or template is persisted (or will be persisted to).
String	getExternalId()	Returns the external identifier.
String	getFullName()	Name of the project and name of the identity.
String	getInternalId()	Returns the internal identifier.
String	getName()	The name of the identity.
SProject	getProject()	Returns the project this build type entity belongs to.
void	setExternalId(String newExternalId)	Changes the external id of this build template or build configuration.
void	setExternalId(ConfigAction cause, String newExternalId)	Changes the external id of this build template or build configuration.
void	setName(String name)	Sets name of this build type or template

Methods inherited from interface jetbrains.buildServer.serverSide.SPersistentEntity

createConfigAction, getConfigId, getConfigurationFile, getParent, getReadOnlyReason, getVersion, isReadOnly, isVirtual, markPersisted, persist, persist, remove, schedulePersisting, schedulePersisting, scheduleRemove

Method Detail

getProject

@NotNull
SProject getProject()

Returns the project this build type entity belongs to.

Returns:

the project this build type entity belongs to.

belongsTo

boolean belongsTo(@NotNull
                  SProject project)

Checks whether this build type or template belongs to the specified project or one of its subprojects, transitively.

Parameters:

project - the project to check this configuration to belongs to.

Returns:

true if belongs.

Since:

8.1

getInternalId

@NotNull
String getInternalId()

Returns the internal identifier.

Returns:

the internal identifier.

getExternalId

@NotNull
String getExternalId()

Returns the external identifier.

Specified by:

getExternalId in interface SPersistentEntity

Returns:

the external identifier.

setExternalId

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

Changes the external id of this build template or build configuration.

This method persists the current entity, and can persist also dependent entities.

Parameters:

newExternalId - new external identifier. Must be unique (case insensitively) in the scope of all build templates and build configurations (in other words, two projects with build configurations with same external id are not allowed).

Throws:

InvalidIdentifierException - wrong identifier

DuplicateExternalIdException - a build template or a build configuration

ObsoleteEntityException - when build type/template is not the same as the one in the project model (since 9.1.2)

ReadOnlyEntityException

setExternalId

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

Changes the external id of this build template or build configuration.

This method persists the current entity, and can persist also dependent entities.

Parameters:

cause - configuration action caused the change

newExternalId - new external identifier. Must be unique (case insensitively) in the scope of all build templates and build configurations (in other words, two projects with build configurations with same external id are not allowed).

Throws:

InvalidIdentifierException - wrong identifier

DuplicateExternalIdException - a build template or a build configuration

ObsoleteEntityException - when build type/template is not the same as the one in the project model (since 9.1.2)

ReadOnlyEntityException

Since:

9.0

getName

@NotNull
String getName()

The name of the identity.

Specified by:

getName in interface SPersistentEntity

Returns:

see above.

See Also:

getFullName(), setName(String)

setName

void setName(@NotNull
             String name)
      throws ReadOnlyEntityException

Sets name of this build type or template

Parameters:

name - the new name

Throws:

ReadOnlyEntityException

See Also:

getName(), getFullName()

getFullName

@NotNull
String getFullName()

Name of the project and name of the identity.

See Also:

getName()

getConfigurationFile

@NotNull
File getConfigurationFile()

Returns the configuration file where this build type or template is persisted (or will be persisted to).

Specified by:

getConfigurationFile in interface SPersistentEntity

Returns:

see above.

Since:

8.0