org.sonar.api.issue

Interface IssueQueryResult

public interface IssueQueryResult

Since:

3.6

Method Summary

Methods

Modifier and Type	Method and Description
ActionPlan	actionPlan(Issue issue)
Collection<ActionPlan>	actionPlans() The action plans involved in the paginated issues().
Component	component(Issue issue)
Collection<Component>	components() The components involved in the paginated issues().
Issue	first() Returns the first issue in the list.
List<Issue>	issues() Non-null paginated list of issues.
boolean	maxResultsReached() True if too many issues have been found.
Paging	paging() Non-null data about paging of issues
Component	project(Issue issue)
Collection<Component>	projects() The projects involved in the paginated issues().
Rule	rule(Issue issue) Returns the rule associated to the given issue.
Collection<Rule>	rules() The rules involved in the paginated issues().
User	user(String login) Returns the user with the given login.
Collection<User>	users() The users involved in the paginated issues(), for example people who added a comment, reported an issue or are assigned to issues.

Method Detail

issues

List<Issue> issues()

Non-null paginated list of issues.

first

Issue first()

Returns the first issue in the list.

Throws:

IllegalStateException - if the list is empty.

rule

Rule rule(Issue issue)

Returns the rule associated to the given issue.

rules

Collection<Rule> rules()

The rules involved in the paginated issues().

component

Component component(Issue issue)

components

Collection<Component> components()

The components involved in the paginated issues().

project

Component project(Issue issue)

projects

Collection<Component> projects()

The projects involved in the paginated issues().

actionPlan

@CheckForNull
ActionPlan actionPlan(Issue issue)

actionPlans

Collection<ActionPlan> actionPlans()

The action plans involved in the paginated issues().

users

Collection<User> users()

The users involved in the paginated issues(), for example people who added a comment, reported an issue or are assigned to issues.

user

@CheckForNull
User user(String login)

Returns the user with the given login. Users that are not returned by users() are ignored.

paging

Paging paging()

Non-null data about paging of issues

maxResultsReached

boolean maxResultsReached()

True if too many issues have been found. In this case results are truncated.