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 and Description
MethodOutcome() 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
MethodOutcome(IIdType theId, IdDt theVersionId) Deprecated. Use the constructor which accepts a single IIdType parameter, and include the logical ID and version ID in that IIdType instance
MethodOutcome(IIdType theId, IdDt theVersionId, IBaseOperationOutcome theBaseOperationOutcome) Deprecated. Use the constructor which accepts a single IdDt parameter, and include the logical ID and version ID in that IdDt instance

Method Summary

Modifier and Type	Method and Description
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.
IdDt	getVersionId() Deprecated. getId() should return the complete ID including version if it is available
MethodOutcome	setCreated(Boolean theCreated) If not null, indicates whether the resource was created (as opposed to being updated).
void	setId(IIdType theId)
void	setOperationOutcome(IBaseOperationOutcome theBaseOperationOutcome) Sets the IBaseOperationOutcome resource to return to the client.
void	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	setVersionId(IdDt theVersionId) Deprecated. Put the ID and version ID into the same IdDt instance and pass it to setId(IIdType)

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

@Deprecated
public MethodOutcome(IIdType theId,
                                 IdDt theVersionId)

Deprecated. Use the constructor which accepts a single IIdType parameter, and include the logical ID and version ID in that IIdType instance

MethodOutcome

@Deprecated
public MethodOutcome(IIdType theId,
                                 IdDt theVersionId,
                                 IBaseOperationOutcome theBaseOperationOutcome)

Deprecated. Use the constructor which accepts a single IdDt parameter, and include the logical ID and version ID in that IdDt instance

MethodOutcome

public MethodOutcome(IIdType theId)

Constructor

Parameters:

theId - The ID of the created/updated resource

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.

getId

public IIdType getId()

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.

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.

getVersionId

@Deprecated
public IdDt getVersionId()

Deprecated. getId() should return the complete ID including version if it is available

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.

setId

public void setId(IIdType theId)

Parameters:

theId - The ID of the created/updated resource

setOperationOutcome

public void setOperationOutcome(IBaseOperationOutcome theBaseOperationOutcome)

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

setResource

public void 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.

setVersionId

@Deprecated
public void setVersionId(IdDt theVersionId)

Deprecated. Put the ID and version ID into the same IdDt instance and pass it to setId(IIdType)