org.guvnor.structure.repositories

Interface PullRequestService

public interface PullRequestService

Service that contains the basic mechanism to administrate pull requests. Every pull request depends on its repository (target repository). The pull request id is unique in every repository, but it can be repeated across them.

Method Summary

Modifier and Type	Method and Description
PullRequest	acceptPullRequest(PullRequest pullRequest) Accepts the provided pull request and merges branches into target.
PullRequest	closePullRequest(PullRequest pullRequest) Closes the provided pull request and changes its status to CLOSED
PullRequest	createPullRequest(String sourceSpace, String sourceRepository, String sourceBranch, String targetSpace, String targetRepository, String targetBranch) Creates a pull request and stores it into the tracking system.
void	deletePullRequest(PullRequest pullRequest) Deletes the pull request.
List<FileDiff>	diff(PullRequest pullRequest) Obtains differences between all files involved in the pull request.
List<PullRequest>	getPullRequestsByBranch(Integer page, Integer pageSize, String repository, String branch) Retrieves pull requests filtered by repository and branch
List<PullRequest>	getPullRequestsByRepository(Integer page, Integer pageSize, String repository) Retrieves pull requests filtered by repository
List<PullRequest>	getPullRequestsByStatus(Integer page, Integer pageSize, String repository, PullRequestStatus status) Retrieves pull requests filtered by repository and branch
PullRequest	rejectPullRequest(PullRequest pullRequest) Rejects the provided pull request and changes its status to REJECTED

Method Detail

createPullRequest

PullRequest createPullRequest(String sourceSpace,
                              String sourceRepository,
                              String sourceBranch,
                              String targetSpace,
                              String targetRepository,
                              String targetBranch)

Creates a pull request and stores it into the tracking system.

Parameters:

sourceSpace - the space containing the origin repository

sourceRepository - the origin repository

sourceBranch - the branch on the origin repository you want to get pulled

targetSpace - the space containing the upstream repository

targetRepository - the upstream repository

targetBranch - the branch where you want impact your changes

Returns:

The object that represents the pull request.

acceptPullRequest

PullRequest acceptPullRequest(PullRequest pullRequest)

Accepts the provided pull request and merges branches into target.

Parameters:

pullRequest - the pull request you want to accept

Returns:

the final state of the pull request as MERGED

rejectPullRequest

PullRequest rejectPullRequest(PullRequest pullRequest)

Rejects the provided pull request and changes its status to REJECTED

Parameters:

pullRequest - the pull request you want to reject.

Returns:

the final state of the pull request as REJECTED.

closePullRequest

PullRequest closePullRequest(PullRequest pullRequest)

Closes the provided pull request and changes its status to CLOSED

Parameters:

pullRequest - the pull request you want to close.

Returns:

the final state of the pull request as CLOSED.

deletePullRequest

void deletePullRequest(PullRequest pullRequest)

Deletes the pull request. This method removes the pull request from tracking repository. The pull request cannot be recovered.

Parameters:

pullRequest - the pull request you want to delete.

getPullRequestsByBranch

List<PullRequest> getPullRequestsByBranch(Integer page,
                                          Integer pageSize,
                                          String repository,
                                          String branch)

Retrieves pull requests filtered by repository and branch

Parameters:

page - the page you want to get

pageSize - the number of pull requests per page

repository - the repository used as filter

branch - the branch used as filter

Returns:

the page of pull requests filtered by repository

getPullRequestsByRepository

List<PullRequest> getPullRequestsByRepository(Integer page,
                                              Integer pageSize,
                                              String repository)

Retrieves pull requests filtered by repository

Parameters:

page - the page you want to get

pageSize - the number of pull requests per page

repository - the repository used as filter

Returns:

the page of pull requests filtered by repository

getPullRequestsByStatus

List<PullRequest> getPullRequestsByStatus(Integer page,
                                          Integer pageSize,
                                          String repository,
                                          PullRequestStatus status)

Retrieves pull requests filtered by repository and branch

Parameters:

page - the page you want to get

pageSize - the number of pull requests per page

repository - the repository used as filter

status - the status used as filter

Returns:

the page of pull requests filtered by repository

diff

List<FileDiff> diff(PullRequest pullRequest)

Obtains differences between all files involved in the pull request.

Parameters:

pullRequest - the pull request to diff.

Returns:

The list of segment differences from files.