Package jetbrains.buildServer.serverSide

Interface BuildTypeIdentityEx

All Superinterfaces:

BuildTypeIdentity, SPersistentEntity

All Known Subinterfaces:

BuildTypeEx, BuildTypeTemplateEx, RemoteBuildTypeEx

All Known Implementing Classes:

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

public interface BuildTypeIdentityEx
extends BuildTypeIdentity

Non-opened 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
EntityId<String>	getEntityId()	Returns the instance of the entity identifier.
BuildTypeSettingsEx	getSettings()
void	sendExtIdChangedEvents(ConfigAction cause, String oldExternalId, String newExternalId)	This method can be used to send external id changed event.
void	setExternalId(ConfigAction configAction, String newId, boolean sendEvents)	Same as {BuildTypeIdentity.setExternalId(ConfigAction, String)} but provides control over events processing.
void	unregister()	Removes this object from project model.

Methods inherited from interface jetbrains.buildServer.serverSide.BuildTypeIdentity

belongsTo, getConfigurationFile, getExternalId, getFullName, getInternalId, getName, getProject, setExternalId, setExternalId, setName

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

getEntityId

@NotNull
EntityId<String> getEntityId()

Returns the instance of the entity identifier.

This instance (not a copy!) that contains immutable internal id and modifiable external id. When one has changed the external id of this build template or configuration, the external id incide this class instance will be changed too.

Returns:

the instance of the entity identifier.

unregister

void unregister()

Removes this object from project model. No changes on disk are performed.

setExternalId

void setExternalId(@NotNull
                   ConfigAction configAction,
                   @NotNull
                   String newId,
                   boolean sendEvents)
            throws InvalidIdentifierException,
                   DuplicateExternalIdException,
                   ObsoleteEntityException

Same as {BuildTypeIdentity.setExternalId(ConfigAction, String)} but provides control over events processing. If parameter sendEvents is false, then no events about changing of the external id will be sent. This mode can be useful if the events will be sent later, for instance, in case of bulk edit ids operation.

Parameters:

configAction -

newId -

sendEvents -

Throws:

InvalidIdentifierException

DuplicateExternalIdException

ObsoleteEntityException

sendExtIdChangedEvents

void sendExtIdChangedEvents(@NotNull
                            ConfigAction cause,
                            @NotNull
                            String oldExternalId,
                            @NotNull
                            String newExternalId)

This method can be used to send external id changed event.

Parameters:

cause -

oldExternalId -

newExternalId -

getSettings

BuildTypeSettingsEx getSettings()

Returns:

Underlying build settings object

Since:

2023.05