Class Bundle.Entry.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.Builder
-
- Enclosing class:
- Bundle.Entry
public static class Bundle.Entry.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
build()
Build theBundle.Entry
Bundle.Entry.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.Bundle.Entry.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.Builder
from(Bundle.Entry entry)
Bundle.Entry.Builder
fullUrl(Uri fullUrl)
The Absolute URL for the resource.Bundle.Entry.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).Bundle.Entry.Builder
link(Bundle.Link... link)
A series of links that provide context to this entry.Bundle.Entry.Builder
link(java.util.Collection<Bundle.Link> link)
A series of links that provide context to this entry.Bundle.Entry.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.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.Builder
request(Bundle.Entry.Request request)
Additional information about how this entry should be processed as part of a transaction or batch.Bundle.Entry.Builder
resource(Resource resource)
The Resource for the entry.Bundle.Entry.Builder
response(Bundle.Entry.Response response)
Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.Bundle.Entry.Builder
search(Bundle.Entry.Search search)
Information about the search process that lead to the creation of this entry.protected void
validate(Bundle.Entry entry)
-
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.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.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.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.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.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
-
link
public Bundle.Entry.Builder link(Bundle.Link... link)
A series of links that provide context to this entry.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
link
- Links related to this entry- Returns:
- A reference to this Builder instance
-
link
public Bundle.Entry.Builder link(java.util.Collection<Bundle.Link> link)
A series of links that provide context to this entry.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
link
- Links related to this entry- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
fullUrl
public Bundle.Entry.Builder fullUrl(Uri fullUrl)
The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: * fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) * Results from operations might involve resources that are not identified.- Parameters:
fullUrl
- URI for resource (Absolute URL server address or URI for UUID/OID)- Returns:
- A reference to this Builder instance
-
resource
public Bundle.Entry.Builder resource(Resource resource)
The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.- Parameters:
resource
- A resource in the bundle- Returns:
- A reference to this Builder instance
-
search
public Bundle.Entry.Builder search(Bundle.Entry.Search search)
Information about the search process that lead to the creation of this entry.- Parameters:
search
- Search related information- Returns:
- A reference to this Builder instance
-
request
public Bundle.Entry.Builder request(Bundle.Entry.Request request)
Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.- Parameters:
request
- Additional execution information (transaction/batch/history)- Returns:
- A reference to this Builder instance
-
response
public Bundle.Entry.Builder response(Bundle.Entry.Response response)
Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.- Parameters:
response
- Results of execution (transaction/batch/history)- Returns:
- A reference to this Builder instance
-
build
public Bundle.Entry build()
Build theBundle.Entry
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
Bundle.Entry
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Entry per the base specification
-
validate
protected void validate(Bundle.Entry entry)
-
from
protected Bundle.Entry.Builder from(Bundle.Entry entry)
-
-