ca.uhn.hl7v2.model.v24.datatype
Class CP

java.lang.Object
  ca.uhn.hl7v2.model.AbstractType
      ca.uhn.hl7v2.model.v24.datatype.CP

All Implemented Interfaces:

Composite, Type, Serializable

public class CP
extends AbstractType
implements Composite

Represents an HL7 CP (composite price) data type. This type consists of the following components:

• price (MO)
• price type (ID)
• from value (NM)
• to value (NM)
• range units (CE)
• range type (ID)

See Also:

Serialized Form

Constructor Summary

CP(Message message)
Creates a new CP type

Method Summary

Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
MO	getCp1_Price() Returns price (component #1).
ID	getCp2_PriceType() Returns price type (component #2).
NM	getCp3_FromValue() Returns from value (component #3).
NM	getCp4_ToValue() Returns to value (component #4).
CE	getCp5_RangeUnits() Returns range units (component #5).
ID	getCp6_RangeType() Returns range type (component #6).
NM	getFromValue() Returns from value (component #3).
MO	getPrice() Returns price (component #1).
ID	getPriceType() Returns price type (component #2).
ID	getRangeType() Returns range type (component #6).
CE	getRangeUnits() Returns range units (component #5).
NM	getToValue() Returns to value (component #4).

Methods inherited from class ca.uhn.hl7v2.model.AbstractType

clear, encode, getExtraComponents, getMessage, getName, parse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Type

clear, encode, getExtraComponents, getMessage, getName, parse

Constructor Detail

CP

public CP(Message message)

Creates a new CP type

Method Detail

getComponents

public Type[] getComponents()

Returns an array containing the data elements.

Specified by:

getComponents in interface Composite

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

Specified by:

getComponent in interface Composite

Parameters:

number - The component number (0-indexed)

Throws:

DataTypeException - if the given element number is out of range.

getPrice

public MO getPrice()

Returns price (component #1). This is a convenience method that saves you from casting and handling an exception.

getCp1_Price

public MO getCp1_Price()

Returns price (component #1). This is a convenience method that saves you from casting and handling an exception.

getPriceType

public ID getPriceType()

Returns price type (component #2). This is a convenience method that saves you from casting and handling an exception.

getCp2_PriceType

public ID getCp2_PriceType()

Returns price type (component #2). This is a convenience method that saves you from casting and handling an exception.

getFromValue

public NM getFromValue()

Returns from value (component #3). This is a convenience method that saves you from casting and handling an exception.

getCp3_FromValue

public NM getCp3_FromValue()

Returns from value (component #3). This is a convenience method that saves you from casting and handling an exception.

getToValue

public NM getToValue()

Returns to value (component #4). This is a convenience method that saves you from casting and handling an exception.

getCp4_ToValue

public NM getCp4_ToValue()

Returns to value (component #4). This is a convenience method that saves you from casting and handling an exception.

getRangeUnits

public CE getRangeUnits()

Returns range units (component #5). This is a convenience method that saves you from casting and handling an exception.

getCp5_RangeUnits

public CE getCp5_RangeUnits()

Returns range units (component #5). This is a convenience method that saves you from casting and handling an exception.

getRangeType

public ID getRangeType()

Returns range type (component #6). This is a convenience method that saves you from casting and handling an exception.

getCp6_RangeType

public ID getCp6_RangeType()

Returns range type (component #6). This is a convenience method that saves you from casting and handling an exception.