Package jetbrains.buildServer.issueTracker

Interface IssuesManager

All Known Implementing Classes:

IssuesManagerImpl

public interface IssuesManager

Contains several methods that are close to ones in IssueProvider: getRelatedIssues and findIssueById. The main difference in these APIs: methods in this class return IssueEx instances, which are different from instances returned by a IssueProvider.

In other words, this is the place where issue wrapping takes place.

Since:

5.0

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

See Also:

IssueWrapper

Method Summary

Modifier and Type	Method	Description
void	fetchIssuesIntoMemory(Collection<IssueEx> issues)	Requests specified issues from corresponding issue trackers to get all of them into cache.
IssueEx	findIssueById(IssueProvider provider, String id)	Returns the issue corresponding to specified id.
IssueEx	findPossiblyExpiredIssue(SIssueProvider provider, String id, VcsModification modification)	Returns the issue data corresponding to the id.
List<IssueEx>	getRelatedIssues(BuildPromotionEx promotion)	Gets all issues related to build promotion
List<IssueEx>	getRelatedIssues(SVcsModification modification)	Gets all issues related to vcs modification
boolean	hasRelatedIssues(BuildPromotionEx promotion)	Returns true if the given promotion has related issues, false otherwise
boolean	isIssueFixedByRelatedModification(IssueEx issue)	Method return true, iff: issue.isFixed() == true, issue.getRelatedModification() != null, getRelatedModification() is the last modification, in which this issue is mentioned.

Method Detail

getRelatedIssues

@NotNull
List<IssueEx> getRelatedIssues(@NotNull
                               BuildPromotionEx promotion)

Gets all issues related to build promotion

Parameters:

promotion - build promotion

Returns:

list of related issues

hasRelatedIssues

boolean hasRelatedIssues(@NotNull
                         BuildPromotionEx promotion)

Returns true if the given promotion has related issues, false otherwise

Parameters:

promotion - promotion of interest

Returns:

see above

Since:

9.0.5

getRelatedIssues

@NotNull
List<IssueEx> getRelatedIssues(@NotNull
                               SVcsModification modification)

Gets all issues related to vcs modification

Parameters:

modification - vcs modification

Returns:

list of related issues

findIssueById

@NotNull
IssueEx findIssueById(@NotNull
                      IssueProvider provider,
                      @NotNull
                      String id)
               throws RetrieveIssueException

Returns the issue corresponding to specified id. The relation is defined by a provider.

Parameters:

provider - issue provider

id - issue id

Returns:

a corresponding issue

Throws:

RetrieveIssueException - if the issue cannot be found for some reason

findPossiblyExpiredIssue

@Nullable
IssueEx findPossiblyExpiredIssue(@NotNull
                                 SIssueProvider provider,
                                 @NotNull
                                 String id,
                                 @Nullable
                                 VcsModification modification)

Returns the issue data corresponding to the id.

See SIssueProvider.findPossiblyExpiredIssue(String) method for more details.

Parameters:

provider - issue provider

id - issue id

modification - related modification for the issue

Returns:

a corresponding issue

isIssueFixedByRelatedModification

boolean isIssueFixedByRelatedModification(@NotNull
                                          IssueEx issue)

Method return true, iff:

• issue.isFixed() == true,
• issue.getRelatedModification() != null,
• getRelatedModification() is the last modification, in which this issue is mentioned.

Parameters:

issue - the issue to check

Returns:

whether specified issue is fixed by its related modification

See Also:

Issue.isResolved(), IssueEx.getRelatedModification()

fetchIssuesIntoMemory

void fetchIssuesIntoMemory(@NotNull
                           Collection<IssueEx> issues)

Requests specified issues from corresponding issue trackers to get all of them into cache.

Note: all fetching is done in the current thread.

Parameters:

issues - the issues to fetch

Since:

7.0