org.hl7.fhir.r4.model

Class Bundle.BundleEntryComponent

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.Element

org.hl7.fhir.r4.model.BackboneElement

org.hl7.fhir.r4.model.Bundle.BundleEntryComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

Bundle

public static class Bundle.BundleEntryComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected UriType	fullUrl The Absolute URL for the resource.
protected List<Bundle.BundleLinkComponent>	link A series of links that provide context to this entry.
protected Bundle.BundleEntryRequestComponent	request Additional information about how this entry should be processed as part of a transaction or batch.
protected Resource	resource The Resource for the entry.
protected Bundle.BundleEntryResponseComponent	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.
protected Bundle.BundleEntrySearchComponent	search Information about the search process that lead to the creation of this entry.

Fields inherited from class org.hl7.fhir.r4.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.r4.model.Element

extension, id

Constructor Summary

Constructors

Constructor and Description
BundleEntryComponent() Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
Bundle.BundleLinkComponent	addLink()
Bundle.BundleEntryComponent	addLink(Bundle.BundleLinkComponent t)
Bundle.BundleEntryComponent	copy()
void	copyValues(Bundle.BundleEntryComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getFullUrl()
UriType	getFullUrlElement()
List<Bundle.BundleLinkComponent>	getLink()
Bundle.BundleLinkComponent	getLink(String theRelation) Returns the link which matches a given relation.
Bundle.BundleLinkComponent	getLinkFirstRep()
Bundle.BundleLinkComponent	getLinkOrCreate(String theRelation) Returns the link which matches a given relation.
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
Bundle.BundleEntryRequestComponent	getRequest()
Resource	getResource()
Bundle.BundleEntryResponseComponent	getResponse()
Bundle.BundleEntrySearchComponent	getSearch()
String[]	getTypesForProperty(int hash, String name)
boolean	hasFullUrl()
boolean	hasFullUrlElement()
boolean	hasLink()
boolean	hasRequest()
boolean	hasResource()
boolean	hasResponse()
boolean	hasSearch()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Bundle.BundleEntryComponent	setFullUrl(String value)
Bundle.BundleEntryComponent	setFullUrlElement(UriType value)
Bundle.BundleEntryComponent	setLink(List<Bundle.BundleLinkComponent> theLink)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Bundle.BundleEntryComponent	setRequest(Bundle.BundleEntryRequestComponent value)
Bundle.BundleEntryComponent	setResource(Resource value)
Bundle.BundleEntryComponent	setResponse(Bundle.BundleEntryResponseComponent value)
Bundle.BundleEntryComponent	setSearch(Bundle.BundleEntrySearchComponent value)

Methods inherited from class org.hl7.fhir.r4.model.BackboneElement

addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r4.model.Element

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension, getModifierExtension, hasModifierExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Field Detail

link

protected List<Bundle.BundleLinkComponent> link

A series of links that provide context to this entry.

fullUrl

protected UriType 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.

resource

protected Resource resource

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

search

protected Bundle.BundleEntrySearchComponent search

Information about the search process that lead to the creation of this entry.

request

protected Bundle.BundleEntryRequestComponent 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.

response

protected Bundle.BundleEntryResponseComponent 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.

Constructor Detail

BundleEntryComponent

public BundleEntryComponent()

Constructor

Method Detail

getLink

public List<Bundle.BundleLinkComponent> getLink()

Returns:

link (A series of links that provide context to this entry.)

setLink

public Bundle.BundleEntryComponent setLink(List<Bundle.BundleLinkComponent> theLink)

Returns:

Returns a reference to this for easy method chaining

hasLink

public boolean hasLink()

addLink

public Bundle.BundleLinkComponent addLink()

addLink

public Bundle.BundleEntryComponent addLink(Bundle.BundleLinkComponent t)

getLinkFirstRep

public Bundle.BundleLinkComponent getLinkFirstRep()

Returns:

The first repetition of repeating field link, creating it if it does not already exist

getFullUrlElement

public UriType getFullUrlElement()

Returns:

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.). This is the underlying object with id, value and extensions. The accessor "getFullUrl" gives direct access to the value

hasFullUrlElement

public boolean hasFullUrlElement()

hasFullUrl

public boolean hasFullUrl()

setFullUrlElement

public Bundle.BundleEntryComponent setFullUrlElement(UriType value)

Parameters:

value - 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.). This is the underlying object with id, value and extensions. The accessor "getFullUrl" gives direct access to the value

getFullUrl

public String getFullUrl()

Returns:

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.

setFullUrl

public Bundle.BundleEntryComponent setFullUrl(String value)

Parameters:

value - 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.

getResource

public Resource getResource()

Returns:

resource (The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.)

hasResource

public boolean hasResource()

setResource

public Bundle.BundleEntryComponent setResource(Resource value)

Parameters:

value - resource (The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.)

getSearch

public Bundle.BundleEntrySearchComponent getSearch()

Returns:

search (Information about the search process that lead to the creation of this entry.)

hasSearch

public boolean hasSearch()

setSearch

public Bundle.BundleEntryComponent setSearch(Bundle.BundleEntrySearchComponent value)

Parameters:

value - search (Information about the search process that lead to the creation of this entry.)

getRequest

public Bundle.BundleEntryRequestComponent getRequest()

Returns:

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.)

hasRequest

public boolean hasRequest()

setRequest

public Bundle.BundleEntryComponent setRequest(Bundle.BundleEntryRequestComponent value)

Parameters:

value - 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.)

getResponse

public Bundle.BundleEntryResponseComponent getResponse()

Returns:

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.)

hasResponse

public boolean hasResponse()

setResponse

public Bundle.BundleEntryComponent setResponse(Bundle.BundleEntryResponseComponent value)

Parameters:

value - 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.)

getLink

public Bundle.BundleLinkComponent getLink(String theRelation)

Returns the link which matches a given relation. If no link is found which matches the given relation, returns null. If more than one link is found which matches the given relation, returns the first matching BundleLinkComponent.

Parameters:

theRelation - The relation, such as "next", or "self. See the constants such as IBaseBundle.LINK_SELF and IBaseBundle.LINK_NEXT.

Returns:

Returns a matching BundleLinkComponent, or null

See Also:

IBaseBundle.LINK_NEXT, IBaseBundle.LINK_PREV, IBaseBundle.LINK_SELF

getLinkOrCreate

public Bundle.BundleLinkComponent getLinkOrCreate(String theRelation)

Returns the link which matches a given relation. If no link is found which matches the given relation, creates a new BundleLinkComponent with the given relation and adds it to this Bundle. If more than one link is found which matches the given relation, returns the first matching BundleLinkComponent.

Parameters:

theRelation - The relation, such as "next", or "self. See the constants such as IBaseBundle.LINK_SELF and IBaseBundle.LINK_NEXT.

Returns:

Returns a matching BundleLinkComponent, or null

See Also:

IBaseBundle.LINK_NEXT, IBaseBundle.LINK_PREV, IBaseBundle.LINK_SELF

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public Bundle.BundleEntryComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Bundle.BundleEntryComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement