Package org.hisp.dhis.response

Class Response

java.lang.Object

org.hisp.dhis.response.BaseHttpResponse

org.hisp.dhis.response.Response

Direct Known Subclasses:

EventResponse, JobInfoResponse, ObjectResponse

public class Response
extends BaseHttpResponse

Message providing information about a DHIS 2 web API response.

Author:

Lars Helge Overland

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	code
protected Object	data
protected String	devMessage
protected String	errorCode
protected String	message
protected Status	status

Fields inherited from class org.hisp.dhis.response.BaseHttpResponse

headers, httpStatusCode

Constructor Summary

Constructors

Constructor	Description
Response(Status status, Integer httpStatusCode, String message)
Response(Status status, Integer httpStatusCode, String message, String errorCode)

Method Summary

Modifier and Type	Method	Description
String	getHeader(String name)	Returns the value of the HTTP header with the given name, or null if not found.
HttpStatus	getHttpStatus()

Methods inherited from class java.lang.Object

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

Field Details

status

protected Status status

code

protected Integer code

message

protected String message

errorCode

protected String errorCode

devMessage

protected String devMessage

data

protected Object data

Constructor Details

Response

public Response(Status status,
 Integer httpStatusCode,
 String message)

Response

public Response(Status status,
 Integer httpStatusCode,
 String message,
 String errorCode)

Method Details

getHttpStatus

public HttpStatus getHttpStatus()

getHeader

public String getHeader(String name)

Returns the value of the HTTP header with the given name, or null if not found.

Parameters:

name - the HTTP header name.

Returns:

the HTTP header value.