Class SubscriptionStatus.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Resource>
-
- org.linuxforhealth.fhir.model.resource.Resource.Builder
-
- org.linuxforhealth.fhir.model.resource.DomainResource.Builder
-
- org.linuxforhealth.fhir.model.resource.SubscriptionStatus.Builder
-
- Enclosing class:
- SubscriptionStatus
public static class SubscriptionStatus.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubscriptionStatus
build()
Build theSubscriptionStatus
SubscriptionStatus.Builder
contained(java.util.Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.SubscriptionStatus.Builder
contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.SubscriptionStatus.Builder
error(java.util.Collection<CodeableConcept> error)
A record of errors that occurred when the server processed a notification.SubscriptionStatus.Builder
error(CodeableConcept... error)
A record of errors that occurred when the server processed a notification.SubscriptionStatus.Builder
eventsSinceSubscriptionStart(java.lang.String eventsSinceSubscriptionStart)
Convenience method for settingeventsSinceSubscriptionStart
.SubscriptionStatus.Builder
eventsSinceSubscriptionStart(String eventsSinceSubscriptionStart)
The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated.SubscriptionStatus.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource.SubscriptionStatus.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected SubscriptionStatus.Builder
from(SubscriptionStatus subscriptionStatus)
SubscriptionStatus.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.SubscriptionStatus.Builder
implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.SubscriptionStatus.Builder
language(Code language)
The base language in which the resource is written.SubscriptionStatus.Builder
meta(Meta meta)
The metadata about the resource.SubscriptionStatus.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.SubscriptionStatus.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.SubscriptionStatus.Builder
notificationEvent(java.util.Collection<SubscriptionStatus.NotificationEvent> notificationEvent)
Detailed information about events relevant to this subscription notification.SubscriptionStatus.Builder
notificationEvent(SubscriptionStatus.NotificationEvent... notificationEvent)
Detailed information about events relevant to this subscription notification.SubscriptionStatus.Builder
status(SubscriptionStatusCode status)
The status of the subscription, which marks the server state for managing the subscription.SubscriptionStatus.Builder
subscription(Reference subscription)
The reference to the Subscription which generated this notification.SubscriptionStatus.Builder
text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human.SubscriptionStatus.Builder
topic(Canonical topic)
The reference to the SubscriptionTopic for the Subscription which generated this notification.SubscriptionStatus.Builder
type(SubscriptionNotificationType type)
The type of event being conveyed with this notificaiton.protected void
validate(SubscriptionStatus subscriptionStatus)
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public SubscriptionStatus.Builder id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.- Overrides:
id
in classDomainResource.Builder
- Parameters:
id
- Logical id of this artifact- Returns:
- A reference to this Builder instance
-
meta
public SubscriptionStatus.Builder meta(Meta meta)
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.- Overrides:
meta
in classDomainResource.Builder
- Parameters:
meta
- Metadata about the resource- Returns:
- A reference to this Builder instance
-
implicitRules
public SubscriptionStatus.Builder implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.- Overrides:
implicitRules
in classDomainResource.Builder
- Parameters:
implicitRules
- A set of rules under which this content was created- Returns:
- A reference to this Builder instance
-
language
public SubscriptionStatus.Builder language(Code language)
The base language in which the resource is written.- Overrides:
language
in classDomainResource.Builder
- Parameters:
language
- Language of the resource content- Returns:
- A reference to this Builder instance
-
text
public SubscriptionStatus.Builder text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.- Overrides:
text
in classDomainResource.Builder
- Parameters:
text
- Text summary of the resource, for human interpretation- Returns:
- A reference to this Builder instance
-
contained
public SubscriptionStatus.Builder contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public SubscriptionStatus.Builder contained(java.util.Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.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:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
extension
public SubscriptionStatus.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource. 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 classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public SubscriptionStatus.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource. 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 classDomainResource.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 SubscriptionStatus.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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 classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public SubscriptionStatus.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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 classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
status
public SubscriptionStatus.Builder status(SubscriptionStatusCode status)
The status of the subscription, which marks the server state for managing the subscription.- Parameters:
status
- requested | active | error | off | entered-in-error- Returns:
- A reference to this Builder instance
-
type
public SubscriptionStatus.Builder type(SubscriptionNotificationType type)
The type of event being conveyed with this notificaiton.This element is required.
- Parameters:
type
- handshake | heartbeat | event-notification | query-status | query-event- Returns:
- A reference to this Builder instance
-
eventsSinceSubscriptionStart
public SubscriptionStatus.Builder eventsSinceSubscriptionStart(java.lang.String eventsSinceSubscriptionStart)
Convenience method for settingeventsSinceSubscriptionStart
.- Parameters:
eventsSinceSubscriptionStart
- Events since the Subscription was created- Returns:
- A reference to this Builder instance
- See Also:
eventsSinceSubscriptionStart(org.linuxforhealth.fhir.model.type.String)
-
eventsSinceSubscriptionStart
public SubscriptionStatus.Builder eventsSinceSubscriptionStart(String eventsSinceSubscriptionStart)
The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.- Parameters:
eventsSinceSubscriptionStart
- Events since the Subscription was created- Returns:
- A reference to this Builder instance
-
notificationEvent
public SubscriptionStatus.Builder notificationEvent(SubscriptionStatus.NotificationEvent... notificationEvent)
Detailed information about events relevant to this subscription notification.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
notificationEvent
- Detailed information about any events relevant to this notification- Returns:
- A reference to this Builder instance
-
notificationEvent
public SubscriptionStatus.Builder notificationEvent(java.util.Collection<SubscriptionStatus.NotificationEvent> notificationEvent)
Detailed information about events relevant to this subscription notification.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:
notificationEvent
- Detailed information about any events relevant to this notification- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
subscription
public SubscriptionStatus.Builder subscription(Reference subscription)
The reference to the Subscription which generated this notification.This element is required.
Allowed resource types for this reference:
- Parameters:
subscription
- Reference to the Subscription responsible for this notification- Returns:
- A reference to this Builder instance
-
topic
public SubscriptionStatus.Builder topic(Canonical topic)
The reference to the SubscriptionTopic for the Subscription which generated this notification.- Parameters:
topic
- Reference to the SubscriptionTopic this notification relates to- Returns:
- A reference to this Builder instance
-
error
public SubscriptionStatus.Builder error(CodeableConcept... error)
A record of errors that occurred when the server processed a notification.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
error
- List of errors on the subscription- Returns:
- A reference to this Builder instance
-
error
public SubscriptionStatus.Builder error(java.util.Collection<CodeableConcept> error)
A record of errors that occurred when the server processed a notification.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:
error
- List of errors on the subscription- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public SubscriptionStatus build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
SubscriptionStatus
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid SubscriptionStatus per the base specification
-
validate
protected void validate(SubscriptionStatus subscriptionStatus)
-
from
protected SubscriptionStatus.Builder from(SubscriptionStatus subscriptionStatus)
-
-