Class Bundle.Entry.Response.Builder
- java.lang.Object
-
- com.ibm.fhir.model.builder.AbstractBuilder<Element>
-
- com.ibm.fhir.model.type.Element.Builder
-
- com.ibm.fhir.model.type.BackboneElement.Builder
-
- com.ibm.fhir.model.resource.Bundle.Entry.Response.Builder
-
- Enclosing class:
- Bundle.Entry.Response
public static class Bundle.Entry.Response.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class com.ibm.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class com.ibm.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Bundle.Entry.Response
build()
Build theBundle.Entry.Response
Bundle.Entry.Response.Builder
etag(String etag)
The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).Bundle.Entry.Response.Builder
etag(java.lang.String etag)
Convenience method for settingetag
.Bundle.Entry.Response.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.Bundle.Entry.Response.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.protected Bundle.Entry.Response.Builder
from(Bundle.Entry.Response response)
Bundle.Entry.Response.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).Bundle.Entry.Response.Builder
lastModified(Instant lastModified)
The date/time that the resource was modified on the server.Bundle.Entry.Response.Builder
lastModified(java.time.ZonedDateTime lastModified)
Convenience method for settinglastModified
.Bundle.Entry.Response.Builder
location(Uri location)
The location header created by processing this operation, populated if the operation returns a location.Bundle.Entry.Response.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.Bundle.Entry.Response.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.Bundle.Entry.Response.Builder
outcome(Resource outcome)
An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.Bundle.Entry.Response.Builder
status(String status)
The status code returned by processing this entry.Bundle.Entry.Response.Builder
status(java.lang.String status)
Convenience method for settingstatus
.protected void
validate(Bundle.Entry.Response response)
-
Methods inherited from class com.ibm.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public Bundle.Entry.Response.Builder id(java.lang.String id)
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.- Overrides:
id
in classBackboneElement.Builder
- Parameters:
id
- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public Bundle.Entry.Response.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public Bundle.Entry.Response.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public Bundle.Entry.Response.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public Bundle.Entry.Response.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
status
public Bundle.Entry.Response.Builder status(java.lang.String status)
Convenience method for settingstatus
.This element is required.
- Parameters:
status
- Status response code (text optional)- Returns:
- A reference to this Builder instance
- See Also:
status(com.ibm.fhir.model.type.String)
-
status
public Bundle.Entry.Response.Builder status(String status)
The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.This element is required.
- Parameters:
status
- Status response code (text optional)- Returns:
- A reference to this Builder instance
-
location
public Bundle.Entry.Response.Builder location(Uri location)
The location header created by processing this operation, populated if the operation returns a location.- Parameters:
location
- The location (if the operation returns a location)- Returns:
- A reference to this Builder instance
-
etag
public Bundle.Entry.Response.Builder etag(java.lang.String etag)
Convenience method for settingetag
.- Parameters:
etag
- The Etag for the resource (if relevant)- Returns:
- A reference to this Builder instance
- See Also:
etag(com.ibm.fhir.model.type.String)
-
etag
public Bundle.Entry.Response.Builder etag(String etag)
The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).- Parameters:
etag
- The Etag for the resource (if relevant)- Returns:
- A reference to this Builder instance
-
lastModified
public Bundle.Entry.Response.Builder lastModified(java.time.ZonedDateTime lastModified)
Convenience method for settinglastModified
.- Parameters:
lastModified
- Server's date time modified- Returns:
- A reference to this Builder instance
- See Also:
lastModified(com.ibm.fhir.model.type.Instant)
-
lastModified
public Bundle.Entry.Response.Builder lastModified(Instant lastModified)
The date/time that the resource was modified on the server.- Parameters:
lastModified
- Server's date time modified- Returns:
- A reference to this Builder instance
-
outcome
public Bundle.Entry.Response.Builder outcome(Resource outcome)
An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.- Parameters:
outcome
- OperationOutcome with hints and warnings (for batch/transaction)- Returns:
- A reference to this Builder instance
-
build
public Bundle.Entry.Response build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
Bundle.Entry.Response
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Response per the base specification
-
validate
protected void validate(Bundle.Entry.Response response)
-
from
protected Bundle.Entry.Response.Builder from(Bundle.Entry.Response response)
-
-