Package org.hl7.fhir.r4.model

Class Subscription.SubscriptionChannelComponent

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.Subscription.SubscriptionChannelComponent

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:

Subscription

public static class Subscription.SubscriptionChannelComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected UrlType	endpoint	The url that describes the actual end-point to send messages to.
protected List<StringType>	header	Additional headers / information to send as part of the notification.
protected CodeType	payload	The mime type to send the payload in - either application/fhir+xml, or application/fhir+json.
protected Enumeration<Subscription.SubscriptionChannelType>	type	The type of channel to send notifications on.

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	Description
SubscriptionChannelComponent()	Constructor
SubscriptionChannelComponent(Enumeration<Subscription.SubscriptionChannelType> type)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Subscription.SubscriptionChannelComponent	addHeader(String value)
StringType	addHeaderElement()
Subscription.SubscriptionChannelComponent	copy()
void	copyValues(Subscription.SubscriptionChannelComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getEndpoint()
UrlType	getEndpointElement()
List<StringType>	getHeader()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
String	getPayload()
CodeType	getPayloadElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
Subscription.SubscriptionChannelType	getType()
Enumeration<Subscription.SubscriptionChannelType>	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasEndpoint()
boolean	hasEndpointElement()
boolean	hasHeader()
boolean	hasHeader(String value)
boolean	hasPayload()
boolean	hasPayloadElement()
boolean	hasType()
boolean	hasTypeElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Subscription.SubscriptionChannelComponent	setEndpoint(String value)
Subscription.SubscriptionChannelComponent	setEndpointElement(UrlType value)
Subscription.SubscriptionChannelComponent	setHeader(List<StringType> theHeader)
Subscription.SubscriptionChannelComponent	setPayload(String value)
Subscription.SubscriptionChannelComponent	setPayloadElement(CodeType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Subscription.SubscriptionChannelComponent	setType(Subscription.SubscriptionChannelType value)
Subscription.SubscriptionChannelComponent	setTypeElement(Enumeration<Subscription.SubscriptionChannelType> value)

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, 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, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN, setXhtml

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

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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

addExtension, getExtension, hasExtension

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

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

type

protected Enumeration<Subscription.SubscriptionChannelType> type

The type of channel to send notifications on.

endpoint

protected UrlType endpoint

The url that describes the actual end-point to send messages to.

payload

protected CodeType payload

The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions.

header

protected List<StringType> header

Additional headers / information to send as part of the notification.

Constructor Details

SubscriptionChannelComponent

public SubscriptionChannelComponent()

Constructor

SubscriptionChannelComponent

public SubscriptionChannelComponent(Enumeration<Subscription.SubscriptionChannelType> type)

Constructor

Method Details

getTypeElement

public Enumeration<Subscription.SubscriptionChannelType> getTypeElement()

Returns:

type (The type of channel to send notifications on.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

hasTypeElement

public boolean hasTypeElement()

hasType

public boolean hasType()

setTypeElement

public Subscription.SubscriptionChannelComponent setTypeElement(Enumeration<Subscription.SubscriptionChannelType> value)

Parameters:

value - type (The type of channel to send notifications on.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

getType

public Subscription.SubscriptionChannelType getType()

Returns:

The type of channel to send notifications on.

setType

public Subscription.SubscriptionChannelComponent setType(Subscription.SubscriptionChannelType value)

Parameters:

value - The type of channel to send notifications on.

getEndpointElement

public UrlType getEndpointElement()

Returns:

endpoint (The url that describes the actual end-point to send messages to.). This is the underlying object with id, value and extensions. The accessor "getEndpoint" gives direct access to the value

hasEndpointElement

public boolean hasEndpointElement()

hasEndpoint

public boolean hasEndpoint()

setEndpointElement

public Subscription.SubscriptionChannelComponent setEndpointElement(UrlType value)

Parameters:

value - endpoint (The url that describes the actual end-point to send messages to.). This is the underlying object with id, value and extensions. The accessor "getEndpoint" gives direct access to the value

getEndpoint

public String getEndpoint()

Returns:

The url that describes the actual end-point to send messages to.

setEndpoint

public Subscription.SubscriptionChannelComponent setEndpoint(String value)

Parameters:

value - The url that describes the actual end-point to send messages to.

getPayloadElement

public CodeType getPayloadElement()

Returns:

payload (The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions.). This is the underlying object with id, value and extensions. The accessor "getPayload" gives direct access to the value

hasPayloadElement

public boolean hasPayloadElement()

hasPayload

public boolean hasPayload()

setPayloadElement

public Subscription.SubscriptionChannelComponent setPayloadElement(CodeType value)

Parameters:

value - payload (The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions.). This is the underlying object with id, value and extensions. The accessor "getPayload" gives direct access to the value

getPayload

public String getPayload()

Returns:

The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions.

setPayload

public Subscription.SubscriptionChannelComponent setPayload(String value)

Parameters:

value - The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions.

getHeader

public List<StringType> getHeader()

Returns:

header (Additional headers / information to send as part of the notification.)

setHeader

public Subscription.SubscriptionChannelComponent setHeader(List<StringType> theHeader)

Returns:

Returns a reference to this for easy method chaining

hasHeader

public boolean hasHeader()

addHeaderElement

public StringType addHeaderElement()

Returns:

header (Additional headers / information to send as part of the notification.)

addHeader

public Subscription.SubscriptionChannelComponent addHeader(String value)

Parameters:

value - header (Additional headers / information to send as part of the notification.)

hasHeader

public boolean hasHeader(String value)

Parameters:

value - header (Additional headers / information to send as part of the notification.)

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

removeChild

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

Overrides:

removeChild 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 Subscription.SubscriptionChannelComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Subscription.SubscriptionChannelComponent 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