Class Subscription.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.Subscription.Builder
-
- Enclosing class:
- Subscription
public static class Subscription.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 Subscription
build()
Build theSubscription
Subscription.Builder
channel(Subscription.Channel channel)
Details where to send notifications when resources are received that meet the criteria.Subscription.Builder
contact(java.util.Collection<ContactPoint> contact)
Contact details for a human to contact about the subscription.Subscription.Builder
contact(ContactPoint... contact)
Contact details for a human to contact about the subscription.Subscription.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.Subscription.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.Subscription.Builder
criteria(java.lang.String criteria)
Convenience method for settingcriteria
.Subscription.Builder
criteria(String criteria)
The rules that the server should use to determine when to generate notifications for this subscription.Subscription.Builder
end(java.time.ZonedDateTime end)
Convenience method for settingend
.Subscription.Builder
end(Instant end)
The time for the server to turn the subscription off.Subscription.Builder
error(java.lang.String error)
Convenience method for settingerror
.Subscription.Builder
error(String error)
A record of the last error that occurred when the server processed a notification.Subscription.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.Subscription.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected Subscription.Builder
from(Subscription subscription)
Subscription.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.Subscription.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.Subscription.Builder
language(Code language)
The base language in which the resource is written.Subscription.Builder
meta(Meta meta)
The metadata about the resource.Subscription.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.Subscription.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.Subscription.Builder
reason(java.lang.String reason)
Convenience method for settingreason
.Subscription.Builder
reason(String reason)
A description of why this subscription is defined.Subscription.Builder
status(SubscriptionStatusCode status)
The status of the subscription, which marks the server state for managing the subscription.Subscription.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.protected void
validate(Subscription subscription)
-
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 Subscription.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 Subscription.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 Subscription.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 Subscription.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 Subscription.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 Subscription.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 Subscription.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 Subscription.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 Subscription.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 Subscription.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 Subscription.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 Subscription.Builder status(SubscriptionStatusCode status)
The status of the subscription, which marks the server state for managing the subscription.This element is required.
- Parameters:
status
- requested | active | error | off- Returns:
- A reference to this Builder instance
-
contact
public Subscription.Builder contact(ContactPoint... contact)
Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
contact
- Contact details for source (e.g. troubleshooting)- Returns:
- A reference to this Builder instance
-
contact
public Subscription.Builder contact(java.util.Collection<ContactPoint> contact)
Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.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:
contact
- Contact details for source (e.g. troubleshooting)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
end
public Subscription.Builder end(java.time.ZonedDateTime end)
Convenience method for settingend
.- Parameters:
end
- When to automatically delete the subscription- Returns:
- A reference to this Builder instance
- See Also:
end(org.linuxforhealth.fhir.model.type.Instant)
-
end
public Subscription.Builder end(Instant end)
The time for the server to turn the subscription off.- Parameters:
end
- When to automatically delete the subscription- Returns:
- A reference to this Builder instance
-
reason
public Subscription.Builder reason(java.lang.String reason)
Convenience method for settingreason
.This element is required.
- Parameters:
reason
- Description of why this subscription was created- Returns:
- A reference to this Builder instance
- See Also:
reason(org.linuxforhealth.fhir.model.type.String)
-
reason
public Subscription.Builder reason(String reason)
A description of why this subscription is defined.This element is required.
- Parameters:
reason
- Description of why this subscription was created- Returns:
- A reference to this Builder instance
-
criteria
public Subscription.Builder criteria(java.lang.String criteria)
Convenience method for settingcriteria
.This element is required.
- Parameters:
criteria
- Rule for server push- Returns:
- A reference to this Builder instance
- See Also:
criteria(org.linuxforhealth.fhir.model.type.String)
-
criteria
public Subscription.Builder criteria(String criteria)
The rules that the server should use to determine when to generate notifications for this subscription.This element is required.
- Parameters:
criteria
- Rule for server push- Returns:
- A reference to this Builder instance
-
error
public Subscription.Builder error(java.lang.String error)
Convenience method for settingerror
.- Parameters:
error
- Latest error note- Returns:
- A reference to this Builder instance
- See Also:
error(org.linuxforhealth.fhir.model.type.String)
-
error
public Subscription.Builder error(String error)
A record of the last error that occurred when the server processed a notification.- Parameters:
error
- Latest error note- Returns:
- A reference to this Builder instance
-
channel
public Subscription.Builder channel(Subscription.Channel channel)
Details where to send notifications when resources are received that meet the criteria.This element is required.
- Parameters:
channel
- The channel on which to report matches to the criteria- Returns:
- A reference to this Builder instance
-
build
public Subscription build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
Subscription
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Subscription per the base specification
-
validate
protected void validate(Subscription subscription)
-
from
protected Subscription.Builder from(Subscription subscription)
-
-