Package ca.uhn.fhir.rest.api

Class MethodOutcome

java.lang.Object

ca.uhn.fhir.rest.api.MethodOutcome

public class MethodOutcome
extends Object

Constructor Summary

Constructors

Constructor	Description
MethodOutcome()	Constructor
MethodOutcome(IBaseOperationOutcome theOperationOutcome)	Constructor
MethodOutcome(IIdType theId)	Constructor
MethodOutcome(IIdType theId, Boolean theCreated)	Constructor
MethodOutcome(IIdType theId, IBaseOperationOutcome theBaseOperationOutcome)	Constructor
MethodOutcome(IIdType theId, IBaseOperationOutcome theBaseOperationOutcome, Boolean theCreated)	Constructor

Method Summary

Modifier and Type	Method	Description
void	fireResourceViewCallbacks()	Fires callbacks registered to registerResourceViewCallback(Runnable) and then clears the list of registered callbacks.
Boolean	getCreated()	This will be set to Boolean.TRUE for instance of MethodOutcome which are returned to client instances, if the server has responded with an HTTP 201 Created.
IIdType	getId()
IBaseOperationOutcome	getOperationOutcome()	Returns the IBaseOperationOutcome resource to return to the client or null if none.
IBaseResource	getResource()	From a client response: If the method returned an actual resource body (e.g.
Map<String,List<String>>	getResponseHeaders()	Gets the headers for the HTTP response
void	registerResourceViewCallback(Runnable theCallback)	Registers a callback to be invoked before the resource in this object gets returned to the client.
MethodOutcome	setCreated(Boolean theCreated)	If not null, indicates whether the resource was created (as opposed to being updated).
void	setCreatedUsingStatusCode(int theResponseStatusCode)
MethodOutcome	setId(IIdType theId)
MethodOutcome	setOperationOutcome(IBaseOperationOutcome theBaseOperationOutcome)	Sets the IBaseOperationOutcome resource to return to the client.
MethodOutcome	setResource(IBaseResource theResource)	In a server response: This field may be populated in server code with the final resource for operations where a resource body is being created/updated.
void	setResponseHeaders(Map<String,List<String>> theResponseHeaders)	Sets the headers for the HTTP response

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodOutcome

public MethodOutcome()

Constructor

MethodOutcome

public MethodOutcome(IIdType theId,
                     Boolean theCreated)

Constructor

Parameters:

theId - The ID of the created/updated resource

theCreated - If not null, indicates whether the resource was created (as opposed to being updated). This is generally not needed, since the server can assume based on the method being called whether the result was a creation or an update. However, it can be useful if you are implementing an update method that does a create if the ID doesn't already exist.

MethodOutcome

public MethodOutcome(IIdType theId,
                     IBaseOperationOutcome theBaseOperationOutcome)

Constructor

Parameters:

theId - The ID of the created/updated resource

theBaseOperationOutcome - The operation outcome to return with the response (or null for none)

MethodOutcome

public MethodOutcome(IIdType theId,
                     IBaseOperationOutcome theBaseOperationOutcome,
                     Boolean theCreated)

Constructor

Parameters:

theId - The ID of the created/updated resource

theBaseOperationOutcome - The operation outcome to return with the response (or null for none)

theCreated - If not null, indicates whether the resource was created (as opposed to being updated). This is generally not needed, since the server can assume based on the method being called whether the result was a creation or an update. However, it can be useful if you are implementing an update method that does a create if the ID doesn't already exist.

MethodOutcome

public MethodOutcome(IIdType theId)

Constructor

Parameters:

theId - The ID of the created/updated resource

MethodOutcome

public MethodOutcome(IBaseOperationOutcome theOperationOutcome)

Constructor

Parameters:

theOperationOutcome - The operation outcome resource to return

Method Detail

getCreated

public Boolean getCreated()

This will be set to Boolean.TRUE for instance of MethodOutcome which are returned to client instances, if the server has responded with an HTTP 201 Created.

setCreated

public MethodOutcome setCreated(Boolean theCreated)

If not null, indicates whether the resource was created (as opposed to being updated). This is generally not needed, since the server can assume based on the method being called whether the result was a creation or an update. However, it can be useful if you are implementing an update method that does a create if the ID doesn't already exist.

Users of HAPI should only interact with this method in Server applications

Parameters:

theCreated - If not null, indicates whether the resource was created (as opposed to being updated). This is generally not needed, since the server can assume based on the method being called whether the result was a creation or an update. However, it can be useful if you are implementing an update method that does a create if the ID doesn't already exist.

Returns:

Returns a reference to this for easy method chaining

getId

public IIdType getId()

setId

public MethodOutcome setId(IIdType theId)

Parameters:

theId - The ID of the created/updated resource

Returns:

Returns a reference to this for easy method chaining

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 MethodOutcome setOperationOutcome(IBaseOperationOutcome theBaseOperationOutcome)

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

Returns:

Returns a reference to this for easy method chaining

getResource

public IBaseResource getResource()

From a client response: If the method returned an actual resource body (e.g. a create/update with "Prefer: return=representation") this field will be populated with the resource itself.

setResource

public MethodOutcome setResource(IBaseResource theResource)

In a server response: This field may be populated in server code with the final resource for operations where a resource body is being created/updated. E.g. for an update method, this field could be populated with the resource after the update is applied, with the new version ID, lastUpdate time, etc.

This field is optional, but if it is populated the server will return the resource body if requested to do so via the HTTP Prefer header.

Returns:

Returns a reference to this for easy method chaining

See Also:

to register a callback that should be invoked by the framework before the resource is shown/returned to a client

getResponseHeaders

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

Gets the headers for the HTTP response

setResponseHeaders

public void setResponseHeaders(Map<String,List<String>> theResponseHeaders)

Sets the headers for the HTTP response

registerResourceViewCallback

public void registerResourceViewCallback(Runnable theCallback)

Registers a callback to be invoked before the resource in this object gets returned to the client. Note that this is an experimental API and may change.

Parameters:

theCallback - The callback

Since:

4.0.0

fireResourceViewCallbacks

public void fireResourceViewCallbacks()

Fires callbacks registered to registerResourceViewCallback(Runnable) and then clears the list of registered callbacks.

Since:

4.0.0

setCreatedUsingStatusCode

public void setCreatedUsingStatusCode(int theResponseStatusCode)