Package org.hl7.fhir.r5.model

Enum MonetaryComponent.PriceComponentType

java.lang.Object

java.lang.Enum<MonetaryComponent.PriceComponentType>

org.hl7.fhir.r5.model.MonetaryComponent.PriceComponentType

All Implemented Interfaces:

Serializable, Comparable<MonetaryComponent.PriceComponentType>

Enclosing class:

MonetaryComponent

public static enum MonetaryComponent.PriceComponentType
extends Enum<MonetaryComponent.PriceComponentType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASE	the amount is the base price used for calculating the total price before applying surcharges, discount or taxes.
DEDUCTION	the amount is a deduction applied on the base price.
DISCOUNT	the amount is a discount applied on the base price.
INFORMATIONAL	the amount is of informational character, it has not been applied in the calculation of the total price.
NULL	added to help the parsers with the generic types
SURCHARGE	the amount is a surcharge applied on the base price.
TAX	the amount is the tax component of the total price.

Method Summary

Modifier and Type	Method	Description
static MonetaryComponent.PriceComponentType	fromCode(String codeString)
String	getDefinition()
String	getDisplay()
String	getSystem()
String	toCode()
static MonetaryComponent.PriceComponentType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MonetaryComponent.PriceComponentType[]	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 Details

BASE

public static final MonetaryComponent.PriceComponentType BASE

the amount is the base price used for calculating the total price before applying surcharges, discount or taxes.

SURCHARGE

public static final MonetaryComponent.PriceComponentType SURCHARGE

the amount is a surcharge applied on the base price.

DEDUCTION

public static final MonetaryComponent.PriceComponentType DEDUCTION

the amount is a deduction applied on the base price.

DISCOUNT

public static final MonetaryComponent.PriceComponentType DISCOUNT

the amount is a discount applied on the base price.

TAX

public static final MonetaryComponent.PriceComponentType TAX

the amount is the tax component of the total price.

INFORMATIONAL

public static final MonetaryComponent.PriceComponentType INFORMATIONAL

the amount is of informational character, it has not been applied in the calculation of the total price.

NULL

public static final MonetaryComponent.PriceComponentType NULL

added to help the parsers with the generic types

Method Details

values

public static MonetaryComponent.PriceComponentType[] values()

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

Returns:

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

valueOf

public static MonetaryComponent.PriceComponentType 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

fromCode

public static MonetaryComponent.PriceComponentType fromCode(String codeString)
                                                     throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

toCode

public String toCode()

getSystem

public String getSystem()

getDefinition

public String getDefinition()

getDisplay

public String getDisplay()