Package jetbrains.buildServer.responsibility

Interface TestNameResponsibilityFacade

All Known Subinterfaces:

ResponsibilityFacadeEx

All Known Implementing Classes:

ResponsibilityFacadeImpl, SecuredResponsibilityFacade

public interface TestNameResponsibilityFacade

Provides the interface to access and modify the responsibility on a test name. Thread-safe.

Since:

5.0

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

Method Summary

Modifier and Type	Method	Description
List<TestNameResponsibilityEntry>	findAllTestNameResponsibilities(long testNameId, String projectId)	Returns all responsibility entries for the test name in a project.
List<TestNameResponsibilityEntry>	findAllTestNameResponsibilities(TestName testName, String projectId)	Returns all responsibility entries for the test name in a project.
TestNameResponsibilityEntry	findTestNameResponsibility(TestName testName, String projectId)	Deprecated. since 8.0, consider using findAllTestNameResponsibilities(jetbrains.buildServer.tests.TestName, String)
List<TestNameResponsibilityEntry>	getUserTestNameResponsibilities(User user, String projectId)	Returns the list of entries associated with the user (if specified) in a specified project.
List<TestNameResponsibilityEntry>	getUserTestNameResponsibilities(User user, Collection<String> projectIds)	Same as {getUserTestNameResponsibilities(User, String) but performs operation for set of project ids.
void	removeTestNameResponsibility(TestName testName, String projectId)	Removes the responsibility entry associated with the test name.
void	setTestNameResponsibility(Collection<TestName> testNames, String projectId, ResponsibilityEntry entry)	Sets the responsibility for several tests at once in a specified project.
void	setTestNameResponsibility(Collection<TestName> testNames, String projectId, ResponsibilityEntry entry, boolean removeResponsibilitiesInChildProjects)	Sets the responsibility for several tests at once in a specified project.
void	setTestNameResponsibility(TestName testName, String projectId, ResponsibilityEntry entry)	Sets the responsibility entry for the test name in a specified project.

Method Detail

findTestNameResponsibility

@Nullable
TestNameResponsibilityEntry findTestNameResponsibility(@NotNull
                                                       TestName testName,
                                                       @NotNull
                                                       String projectId)

Deprecated.

since 8.0, consider using findAllTestNameResponsibilities(jetbrains.buildServer.tests.TestName, String)

Returns the responsibility entry for a test name in a project, or null if it does not exist.

Parameters:

testName - the test name

projectId - project internal id

Returns:

responsibility entry, or null

findAllTestNameResponsibilities

@NotNull
List<TestNameResponsibilityEntry> findAllTestNameResponsibilities(@NotNull
                                                                  TestName testName,
                                                                  @NotNull
                                                                  String projectId)

Returns all responsibility entries for the test name in a project.

Parameters:

testName - the test name

projectId - project internal id

Returns:

list of entries for this test; since 2018.1 entries of the given projectId go first in the list

Since:

8.0

findAllTestNameResponsibilities

@NotNull
List<TestNameResponsibilityEntry> findAllTestNameResponsibilities(long testNameId,
                                                                  @NotNull
                                                                  String projectId)

Returns all responsibility entries for the test name in a project.

Parameters:

testNameId - the test name ID

projectId - project internal id

Returns:

list of entries for this test; since 2018.1 entries of the given projectId go first in the list

Since:

2020.2

getUserTestNameResponsibilities

@NotNull
List<TestNameResponsibilityEntry> getUserTestNameResponsibilities(@Nullable
                                                                  User user,
                                                                  @Nullable
                                                                  String projectId)

Returns the list of entries associated with the user (if specified) in a specified project.

Parameters:

user - the responsible user; null means all users

projectId - the project internal id; null means all projects

Returns:

list of responsibilities

Since:

projectId is nullable since TeamCity 7.0

getUserTestNameResponsibilities

@NotNull
List<TestNameResponsibilityEntry> getUserTestNameResponsibilities(@Nullable
                                                                  User user,
                                                                  @NotNull
                                                                  Collection<String> projectIds)

Same as {getUserTestNameResponsibilities(User, String) but performs operation for set of project ids.

Parameters:

user - the responsible user; null means all users

projectIds - collection of project internal ids

Returns:

list of responsibilities in requested projects

Since:

2017.2

setTestNameResponsibility

void setTestNameResponsibility(@NotNull
                               TestName testName,
                               @NotNull
                               String projectId,
                               @NotNull
                               ResponsibilityEntry entry)

Sets the responsibility entry for the test name in a specified project.

Note: if new reporter user isn't set (entry.getReporterUser() == null), it is not overwritten.

Parameters:

testName - the test name

projectId - the project internal id

entry - responsibility entry

setTestNameResponsibility

void setTestNameResponsibility(@NotNull
                               Collection<TestName> testNames,
                               @NotNull
                               String projectId,
                               @NotNull
                               ResponsibilityEntry entry)

Sets the responsibility for several tests at once in a specified project.

Parameters:

testNames - collection of test names

projectId - the project internal id

entry - new responsibility entry

Since:

6.0

See Also:

#setTestNameResponsibility(TestName, String, ResponsibilityEntry, Boolean)

setTestNameResponsibility

void setTestNameResponsibility(@NotNull
                               Collection<TestName> testNames,
                               @NotNull
                               String projectId,
                               @NotNull
                               ResponsibilityEntry entry,
                               boolean removeResponsibilitiesInChildProjects)

Sets the responsibility for several tests at once in a specified project.

Parameters:

testNames - collection of test names

projectId - the project internal id

entry - new responsibility entry

removeResponsibilitiesInChildProjects - indiciates whether relevant responsibilities in child projects should be removed.

Since:

2024.07

removeTestNameResponsibility

void removeTestNameResponsibility(@NotNull
                                  TestName testName,
                                  @NotNull
                                  String projectId)

Removes the responsibility entry associated with the test name.

Parameters:

testName - the test name

projectId - the project internal id