Package ca.uhn.fhir.rest.api

Class StringOutcome

java.lang.Object

ca.uhn.fhir.rest.api.StringOutcome

All Implemented Interfaces:

IHasHeaders

public class StringOutcome
extends Object
implements IHasHeaders

Response of a http request which can return a String payload

Constructor Summary

Constructors

Constructor	Description
StringOutcome()
StringOutcome(int theResponseStatus, String thePayload, Map<String,List<String>> theHeaders)

Method Summary

Modifier and Type	Method	Description
void	addHeader(String theHeaderKey, String theHeaderValue)	Adds a header to the response
IBaseOperationOutcome	getOperationOutcome()	Returns the IBaseOperationOutcome resource to return to the client or null if none.
String	getPayload()	Returns the String payload to return to the client or null if none.
Map<String,List<String>>	getResponseHeaders()	Gets the headers for the HTTP response
int	getResponseStatus()	Gets the HTTP response status
StringOutcome	setOperationOutcome(IBaseOperationOutcome theBaseOperationOutcome)	Sets the IBaseOperationOutcome resource to return to the client.
void	setPayload(String thePayload)	Sets the String payload to return to the client or null if none.

Methods inherited from class java.lang.Object

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

Constructor Details

StringOutcome

public StringOutcome(int theResponseStatus,
 String thePayload,
 Map<String,List<String>> theHeaders)

StringOutcome

public StringOutcome()

Method Details

getPayload

public String getPayload()

Returns the String payload to return to the client or null if none.

Returns:

This method may return null, unlike many methods in the API.

setPayload

public void setPayload(String thePayload)

Sets the String payload to return to the client or null if none.

getOperationOutcome

public IBaseOperationOutcome getOperationOutcome()

Returns the IBaseOperationOutcome resource to return to the client or null if none.

Returns:

This method will return null, unlike many methods in the API.

setOperationOutcome

public StringOutcome setOperationOutcome(IBaseOperationOutcome theBaseOperationOutcome)

Sets the IBaseOperationOutcome resource to return to the client. Set to null (which is the default) if none.

Returns:

a reference to this for easy method chaining

getResponseHeaders

public Map<String,List<String>> getResponseHeaders()

Gets the headers for the HTTP response

Specified by:

getResponseHeaders in interface IHasHeaders

addHeader

public void addHeader(String theHeaderKey,
 String theHeaderValue)

Adds a header to the response

getResponseStatus

public int getResponseStatus()

Gets the HTTP response status