Package ca.uhn.hl7v2.model.v251.datatype

Class VID

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v251.datatype.VID

All Implemented Interfaces:

Composite, Type, Visitable, Serializable

public class VID
extends AbstractComposite

Represents an HL7 VID (Version Identifier) data type. This type consists of the following components:

• Version ID (ID)
• Internationalization Code (CE)
• International Version ID (CE)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
VID(Message message)	Creates a new VID type

Method Summary

Modifier and Type	Method	Description
Type	getComponent(int number)	Returns an individual data component.
Type[]	getComponents()	Returns an array containing the data elements.
CE	getInternationalizationCode()	Returns Internationalization Code (component 2).
CE	getInternationalVersionID()	Returns International Version ID (component 3).
ID	getVersionID()	Returns Version ID (component 1).
ID	getVid1_VersionID()	Returns Version ID (component 1).
CE	getVid2_InternationalizationCode()	Returns Internationalization Code (component 2).
CE	getVid3_InternationalVersionID()	Returns International Version ID (component 3).

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

accept, clear, getTyped, isEmpty, provideLocation

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

encode, getExtraComponents, getMessage, getName, parse, toString

Methods inherited from class java.lang.Object

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

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

encode, getExtraComponents, getMessage, getName, parse

Constructor Details

VID

public VID(Message message)

Creates a new VID type

Method Details

getComponents

public Type[] getComponents()

Returns an array containing the data elements.

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

Parameters:

number - The component number (0-indexed)

Throws:

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

getVersionID

public ID getVersionID()

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

getVid1_VersionID

public ID getVid1_VersionID()

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

getInternationalizationCode

public CE getInternationalizationCode()

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

getVid2_InternationalizationCode

public CE getVid2_InternationalizationCode()

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

getInternationalVersionID

public CE getInternationalVersionID()

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

getVid3_InternationalVersionID

public CE getVid3_InternationalVersionID()

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