Package ca.uhn.fhir.jpa.subscription.module

Enum CanonicalSubscriptionChannelType

java.lang.Object

java.lang.Enum<CanonicalSubscriptionChannelType>

ca.uhn.fhir.jpa.subscription.module.CanonicalSubscriptionChannelType

All Implemented Interfaces:

Serializable, Comparable<CanonicalSubscriptionChannelType>

public enum CanonicalSubscriptionChannelType
extends Enum<CanonicalSubscriptionChannelType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMAIL	The channel is executed by sending an email to the email addressed in the URI (which must be a mailto:).
MESSAGE	The channel is executed by sending a message (e.g.
NULL	added to help the parsers with the generic types
RESTHOOK	The channel is executed by making a post to the URI.
SMS	The channel is executed by sending an SMS message to the phone number identified in the URL (tel:).
WEBSOCKET	The channel is executed by sending a packet across a web socket connection maintained by the client.

Method Summary

Modifier and Type	Method	Description
static CanonicalSubscriptionChannelType	fromCode(String theSystem, String codeString)
String	getDefinition()
String	getDisplay()
String	getSystem()
org.hl7.fhir.dstu2.model.Subscription.SubscriptionChannelType	toCanonical()
String	toCode()
static CanonicalSubscriptionChannelType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CanonicalSubscriptionChannelType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RESTHOOK

public static final CanonicalSubscriptionChannelType RESTHOOK

The channel is executed by making a post to the URI. If a payload is included, the URL is interpreted as the service base, and an update (PUT) is made.

WEBSOCKET

public static final CanonicalSubscriptionChannelType WEBSOCKET

The channel is executed by sending a packet across a web socket connection maintained by the client. The URL identifies the websocket, and the client binds to this URL.

EMAIL

public static final CanonicalSubscriptionChannelType EMAIL

The channel is executed by sending an email to the email addressed in the URI (which must be a mailto:).

SMS

public static final CanonicalSubscriptionChannelType SMS

The channel is executed by sending an SMS message to the phone number identified in the URL (tel:).

MESSAGE

public static final CanonicalSubscriptionChannelType MESSAGE

The channel is executed by sending a message (e.g. a Bundle with a MessageHeader resource etc.) to the application identified in the URI.

NULL

public static final CanonicalSubscriptionChannelType NULL

added to help the parsers with the generic types

Method Detail

values

public static CanonicalSubscriptionChannelType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CanonicalSubscriptionChannelType c : CanonicalSubscriptionChannelType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CanonicalSubscriptionChannelType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toCode

public String toCode()

getSystem

public String getSystem()

getDefinition

public String getDefinition()

getDisplay

public String getDisplay()

toCanonical

public org.hl7.fhir.dstu2.model.Subscription.SubscriptionChannelType toCanonical()

fromCode

public static CanonicalSubscriptionChannelType fromCode(@Nullable
                                                        String theSystem,
                                                        @Nonnull
                                                        String codeString)
                                                 throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException