com.atlassian.bamboo.plan.pullrequest

Interface VcsPullRequestService

All Known Implementing Classes:

VcsPullRequestServiceImpl

@ExperimentalApi
public interface VcsPullRequestService

Since:

6.0

Method Summary

Modifier and Type	Method and Description
void	closePullRequest(VcsPullRequest pullRequest) Mark pull request as closed.
void	closePullRequestsClosedInRepository(long targetRepositoryId, List<VcsPullRequest> openPullRequests) Synchronize the status of pull requests in DB and in remote repository
VcsPullRequest	createPullRequest(String pullRequestKey, Long sourceRepositoryId, String sourceBranch, long targetRepositoryId, String targetBranch, boolean isOpen) Create new pull request and save it.
VcsPullRequest	findByRepositoryAndKey(long targetRepositoryId, String pullRequestKey) Search pull request by pull request key (unique on repository level) and target repository id
List<VcsPullRequest>	findOpenByRepository(long targetRepositoryId) Search open pull requests by target repository and status.
void	updatePullRequest(VcsPullRequest pullRequest, Long sourceRepositoryId, String source, String target, boolean isOpen) Modify pull request.

Method Detail

findByRepositoryAndKey

@Nullable
VcsPullRequest findByRepositoryAndKey(long targetRepositoryId,
                                                @NotNull
                                                String pullRequestKey)

Search pull request by pull request key (unique on repository level) and target repository id

Parameters:

targetRepositoryId - target repository id

pullRequestKey - repository-specific pull request key

Returns:

pull request or null if not found

findOpenByRepository

List<VcsPullRequest> findOpenByRepository(long targetRepositoryId)

Search open pull requests by target repository and status.

Parameters:

targetRepositoryId - target repository id

Returns:

list of pull requests

closePullRequest

void closePullRequest(@NotNull
                      VcsPullRequest pullRequest)

Mark pull request as closed.

Parameters:

pullRequest -

createPullRequest

@NotNull
VcsPullRequest createPullRequest(@NotNull
                                          String pullRequestKey,
                                          @Nullable
                                          Long sourceRepositoryId,
                                          @NotNull
                                          String sourceBranch,
                                          long targetRepositoryId,
                                          @NotNull
                                          String targetBranch,
                                          boolean isOpen)

Create new pull request and save it.

Returns:

created pull request

updatePullRequest

void updatePullRequest(@NotNull
                       VcsPullRequest pullRequest,
                       @Nullable
                       Long sourceRepositoryId,
                       @NotNull
                       String source,
                       @NotNull
                       String target,
                       boolean isOpen)

Modify pull request.

closePullRequestsClosedInRepository

void closePullRequestsClosedInRepository(long targetRepositoryId,
                                         @NotNull
                                         List<VcsPullRequest> openPullRequests)

Synchronize the status of pull requests in DB and in remote repository

Parameters:

targetRepositoryId -

openPullRequests -