Class SubscriptionStatus
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.SubscriptionStatus
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class SubscriptionStatus extends DomainResource
The SubscriptionStatus resource describes the state of a Subscription during notifications.Maturity level: FMM0 (draft)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SubscriptionStatus.Builder
static class
SubscriptionStatus.NotificationEvent
Detailed information about events relevant to this subscription notification.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static SubscriptionStatus.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<CodeableConcept>
getError()
A record of errors that occurred when the server processed a notification.String
getEventsSinceSubscriptionStart()
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.java.util.List<SubscriptionStatus.NotificationEvent>
getNotificationEvent()
Detailed information about events relevant to this subscription notification.SubscriptionStatusCode
getStatus()
The status of the subscription, which marks the server state for managing the subscription.Reference
getSubscription()
The reference to the Subscription which generated this notification.Canonical
getTopic()
The reference to the SubscriptionTopic for the Subscription which generated this notification.SubscriptionNotificationType
getType()
The type of event being conveyed with this notificaiton.boolean
hasChildren()
int
hashCode()
SubscriptionStatus.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getStatus
public SubscriptionStatusCode getStatus()
The status of the subscription, which marks the server state for managing the subscription.- Returns:
- An immutable object of type
SubscriptionStatusCode
that may be null.
-
getType
public SubscriptionNotificationType getType()
The type of event being conveyed with this notificaiton.- Returns:
- An immutable object of type
SubscriptionNotificationType
that is non-null.
-
getEventsSinceSubscriptionStart
public String getEventsSinceSubscriptionStart()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getNotificationEvent
public java.util.List<SubscriptionStatus.NotificationEvent> getNotificationEvent()
Detailed information about events relevant to this subscription notification.- Returns:
- An unmodifiable list containing immutable objects of type
SubscriptionStatus.NotificationEvent
that may be empty.
-
getSubscription
public Reference getSubscription()
The reference to the Subscription which generated this notification.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getTopic
public Canonical getTopic()
The reference to the SubscriptionTopic for the Subscription which generated this notification.- Returns:
- An immutable object of type
Canonical
that may be null.
-
getError
public java.util.List<CodeableConcept> getError()
A record of errors that occurred when the server processed a notification.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public SubscriptionStatus.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static SubscriptionStatus.Builder builder()
-
-