com.atlassian.crucible.spi.services

Interface ReviewerSearchService

@ExperimentalApi
public interface ReviewerSearchService

Service for querying matching review participants (users and groups) and for resolving group members which are allowed to participate in review.

Method Summary

Modifier and Type	Method and Description
Page<ReviewerSearchResult.UserResult>	getGroupMembersAllowedForReview(PermId<ReviewData> reviewId, java.lang.String group, PageRequest pageRequest) Get paged list of group members which could be valid reviewers
Page<ReviewerSearchResult>	searchReviewers(PermId<ReviewData> reviewId, java.lang.String query, PageRequest pageRequest, boolean includeUsers, boolean includeGroups) Get paged list of users (which are allowed to review) and groups matching given query

Method Detail

searchReviewers

Page<ReviewerSearchResult> searchReviewers(PermId<ReviewData> reviewId,
                                           java.lang.String query,
                                           PageRequest pageRequest,
                                           boolean includeUsers,
                                           boolean includeGroups)

Get paged list of users (which are allowed to review) and groups matching given query

Parameters:

reviewId - review id determining allowed reviewers

query - the query string to search groups containing the string in the name, and to search users containing the string in username, name and email

pageRequest - the page request object

includeUsers - true if it should search users by username, displayname and email

includeGroups - true if it should search groups by name

Returns:

Page with matching results, available for the given review

Throws:

NotPermittedException - if the authenticated user has no permission to edit the review

NotFoundException - if the review doesn't exist

getGroupMembersAllowedForReview

Page<ReviewerSearchResult.UserResult> getGroupMembersAllowedForReview(PermId<ReviewData> reviewId,
                                                                      java.lang.String group,
                                                                      PageRequest pageRequest)

Get paged list of group members which could be valid reviewers

Parameters:

reviewId - review id determining allowed reviewers

group - group name whose members should be returned, if the group doesn't exists, empty results will be returned

pageRequest - the page request object

Returns:

Page with users being valid to add as reviewers

Throws:

NotPermittedException - if the authenticated user has no permission to edit the review

NotFoundException - if the review doesn't exist