com.atlassian.jira.rest.client.domain
Class SearchResult

java.lang.Object
  com.atlassian.jira.rest.client.domain.SearchResult

public class SearchResult
extends Object

Represents search results - links to issues matching given filter (JQL query) with basic information supporting the paging through the results.

Since:

v0.2

Constructor Summary

SearchResult(int startIndex, int maxResults, int total, Iterable<BasicIssue> issues)

Method Summary

boolean	equals(Object obj)
Iterable<BasicIssue>	getIssues()
int	getMaxResults()
int	getStartIndex()
int	getTotal()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchResult

public SearchResult(int startIndex,
                    int maxResults,
                    int total,
                    Iterable<BasicIssue> issues)

Method Detail

getStartIndex

public int getStartIndex()

Returns:

0-based start index of the returned issues (e.g. "3" means that 4th, 5th...maxResults issues matching given query have been returned.

getMaxResults

public int getMaxResults()

Returns:

maximum page size (the window to results).

getTotal

public int getTotal()

Returns:

total number of issues (regardless of current maxResults and startIndex) matching given criteria. Query JIRA another time with different startIndex to get subsequent issues

getIssues

public Iterable<BasicIssue> getIssues()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object