com.atlassian.crucible.spi.services

Interface SearchService

public interface SearchService

Provides an API for searching reviews.

Method Summary

Modifier and Type	Method and Description
java.util.List<ReviewData>	searchForReviews(java.lang.String term)
java.util.List<ReviewData>	searchForReviews(java.lang.String term, java.lang.Integer limit) Search for reviews where the name, description, summary, author, state, linked review, linked issue, or permaId contain the specified term.
java.util.List<ReviewData>	searchForReviewsByJiraKey(java.lang.String key) Get a list of all reviews that have been linked to the specified Jira issue key.
java.util.List<ReviewData>	searchReviewForTerm(java.lang.String term, java.lang.Integer start, java.lang.Integer limit, java.lang.String projectKey) Search for reviews where the name, description, summary, author, state, linked review, linked issue, or permaId contain the specified term.

Method Detail

searchForReviews

java.util.List<ReviewData> searchForReviews(java.lang.String term)

searchForReviews

java.util.List<ReviewData> searchForReviews(java.lang.String term,
                                            java.lang.Integer limit)

Search for reviews where the name, description, summary, author, state, linked review, linked issue, or permaId contain the specified term.

Parameters:

term - a String term

limit -

Returns:

a List of ReviewData matching the term

searchForReviewsByJiraKey

java.util.List<ReviewData> searchForReviewsByJiraKey(java.lang.String key)

Get a list of all reviews that have been linked to the specified Jira issue key.

Parameters:

key - a Jira issue key (generally of the form ABC-123)

Returns:

a List of reviews linked to the specified key

searchReviewForTerm

java.util.List<ReviewData> searchReviewForTerm(java.lang.String term,
                                               java.lang.Integer start,
                                               java.lang.Integer limit,
                                               java.lang.String projectKey)

Search for reviews where the name, description, summary, author, state, linked review, linked issue, or permaId contain the specified term.

Parameters:

term - - search string

limit - - the maximum number of results to return. If null, all results are returned.

projectKey - - a project to restrict the search to. If null all projects will be searched

Returns:

a list of the selected items ordered by descending review id