org.sonar.wsclient.services

Class ReviewQuery

java.lang.Object

org.sonar.wsclient.services.AbstractQuery<MODEL>

org.sonar.wsclient.services.Query<Review>

org.sonar.wsclient.services.ReviewQuery

public class ReviewQuery
extends Query<Review>

Since:

2.8

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_URL
static String	OUTPUT_HTML
static String	OUTPUT_PLAIN

Fields inherited from class org.sonar.wsclient.services.AbstractQuery

DEFAULT_TIMEOUT_MILLISECONDS

Constructor Summary

Constructors

Constructor and Description
ReviewQuery()

Method Summary

Methods

Modifier and Type	Method and Description
static ReviewQuery	createForResource(Resource resource)
static ReviewQuery	createForReview(Long id)
String[]	getAssigneeLogins()
String[]	getAssigneeLoginsOrIds() Deprecated. since 3.0. Searching by user ID is not possible anymore. Use getAssigneeLogins() instead.
String[]	getAuthorLogins()
String[]	getAuthorLoginsOrIds() Deprecated. since 3.0. Searching by user ID is not possible anymore. Use getAuthorLogins() instead.
Long	getId()
Long[]	getIds()
Class<Review>	getModelClass()
String	getOutput()
String[]	getProjectKeysOrIds()
String[]	getResolutions()
String[]	getResourceKeysOrIds()
String	getReviewType() Deprecated. since 2.9
String[]	getSeverities()
String[]	getStatuses()
String	getUrl() Must start with a slash, for example: /api/metrics
ReviewQuery	setAssigneeLogins(String... assigneeLogins)
ReviewQuery	setAssigneeLoginsOrIds(String... assigneeLoginsOrIds) Deprecated. since 3.0. Searching by user ID is not possible anymore. Use setAssigneeLogins(String...) instead.
ReviewQuery	setAuthorLogins(String... authorLogins)
ReviewQuery	setAuthorLoginsOrIds(String... authorLoginsOrIds) Deprecated. since 3.0. Searching by user ID is not possible anymore. Use setAuthorLogins(String...) instead.
ReviewQuery	setId(Long id)
ReviewQuery	setIds(Long... ids)
ReviewQuery	setOutput(String output)
ReviewQuery	setProjectKeysOrIds(String... projectKeysOrIds)
ReviewQuery	setResolutions(String... resolutions)
ReviewQuery	setResourceKeysOrIds(String... resourceKeysOrIds)
ReviewQuery	setReviewType(String reviewType) Deprecated. since 2.9
ReviewQuery	setSeverities(String... severities)
ReviewQuery	setStatuses(String... statuses)

Methods inherited from class org.sonar.wsclient.services.AbstractQuery

appendUrlParameter, appendUrlParameter, appendUrlParameter, encode, getBody, getLocale, getTimeoutMilliseconds, setLocale, setTimeoutMilliseconds

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BASE_URL

public static final String BASE_URL

See Also:

Constant Field Values

OUTPUT_PLAIN

public static final String OUTPUT_PLAIN

See Also:

Constant Field Values

OUTPUT_HTML

public static final String OUTPUT_HTML

See Also:

Constant Field Values

Constructor Detail

ReviewQuery

public ReviewQuery()

Method Detail

getReviewType

@Deprecated
public String getReviewType()

Deprecated. since 2.9

Returns:

NULL

setReviewType

@Deprecated
public ReviewQuery setReviewType(String reviewType)

Deprecated. since 2.9

Parameters:

reviewType - the reviewType to set

getId

public Long getId()

Returns:

the id

setId

public ReviewQuery setId(Long id)

Parameters:

id - the id to set

getIds

public Long[] getIds()

Returns:

the ids

setIds

public ReviewQuery setIds(Long... ids)

Parameters:

ids - the ids to set

getStatuses

public String[] getStatuses()

Returns:

the statuses

setStatuses

public ReviewQuery setStatuses(String... statuses)

Parameters:

statuses - the statuses to set

getSeverities

public String[] getSeverities()

Returns:

the severities

setSeverities

public ReviewQuery setSeverities(String... severities)

Parameters:

severities - the severities to set

getProjectKeysOrIds

public String[] getProjectKeysOrIds()

Returns:

the projectKeysOrIds

setProjectKeysOrIds

public ReviewQuery setProjectKeysOrIds(String... projectKeysOrIds)

Parameters:

projectKeysOrIds - the projectKeysOrIds to set

getResourceKeysOrIds

public String[] getResourceKeysOrIds()

Returns:

the resourceKeysOrIds

setResourceKeysOrIds

public ReviewQuery setResourceKeysOrIds(String... resourceKeysOrIds)

Parameters:

resourceKeysOrIds - the resourceKeysOrIds to set

getAuthorLoginsOrIds

@Deprecated
public String[] getAuthorLoginsOrIds()

Deprecated. since 3.0. Searching by user ID is not possible anymore. Use getAuthorLogins() instead.

setAuthorLoginsOrIds

@Deprecated
public ReviewQuery setAuthorLoginsOrIds(String... authorLoginsOrIds)

Deprecated. since 3.0. Searching by user ID is not possible anymore. Use setAuthorLogins(String...) instead.

getAuthorLogins

public String[] getAuthorLogins()

Returns:

the authorLogins

setAuthorLogins

public ReviewQuery setAuthorLogins(String... authorLogins)

Parameters:

authorLogins - the authorLogins to set

getAssigneeLoginsOrIds

@Deprecated
public String[] getAssigneeLoginsOrIds()

Deprecated. since 3.0. Searching by user ID is not possible anymore. Use getAssigneeLogins() instead.

setAssigneeLoginsOrIds

@Deprecated
public ReviewQuery setAssigneeLoginsOrIds(String... assigneeLoginsOrIds)

Deprecated. since 3.0. Searching by user ID is not possible anymore. Use setAssigneeLogins(String...) instead.

getAssigneeLogins

public String[] getAssigneeLogins()

Returns:

the assigneeLogins

setAssigneeLogins

public ReviewQuery setAssigneeLogins(String... assigneeLogins)

Parameters:

assigneeLogins - the assigneeLogins to set

getOutput

public String getOutput()

Returns:

the output

setOutput

public ReviewQuery setOutput(String output)

Parameters:

output - the output

getResolutions

public String[] getResolutions()

Since:

2.9

setResolutions

public ReviewQuery setResolutions(String... resolutions)

Since:

2.9

getUrl

public String getUrl()

Description copied from class: AbstractQuery

Must start with a slash, for example: /api/metrics

IMPORTANT: In implementations of this method we must use helper methods to construct URL.

Specified by:

getUrl in class AbstractQuery<Review>

See Also:

AbstractQuery.encode(String), AbstractQuery.appendUrlParameter(StringBuilder, String, Object), AbstractQuery.appendUrlParameter(StringBuilder, String, Object[]), AbstractQuery.appendUrlParameter(StringBuilder, String, Date, boolean)

getModelClass

public Class<Review> getModelClass()

Specified by:

getModelClass in class Query<Review>

createForReview

public static ReviewQuery createForReview(Long id)

createForResource

public static ReviewQuery createForResource(Resource resource)