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

Class MSG

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v251.datatype.MSG

All Implemented Interfaces:

Composite, Type, Visitable, Serializable

public class MSG
extends AbstractComposite

Represents an HL7 MSG (Message Type) data type. This type consists of the following components:

• Message Code (ID)
• Trigger Event (ID)
• Message Structure (ID)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MSG(Message message)	Creates a new MSG 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.
ID	getMessageCode()	Returns Message Code (component 1).
ID	getMessageStructure()	Returns Message Structure (component 3).
ID	getMsg1_MessageCode()	Returns Message Code (component 1).
ID	getMsg2_TriggerEvent()	Returns Trigger Event (component 2).
ID	getMsg3_MessageStructure()	Returns Message Structure (component 3).
ID	getTriggerEvent()	Returns Trigger Event (component 2).

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

MSG

public MSG(Message message)

Creates a new MSG 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.

getMessageCode

public ID getMessageCode()

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

getMsg1_MessageCode

public ID getMsg1_MessageCode()

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

getTriggerEvent

public ID getTriggerEvent()

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

getMsg2_TriggerEvent

public ID getMsg2_TriggerEvent()

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

getMessageStructure

public ID getMessageStructure()

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

getMsg3_MessageStructure

public ID getMsg3_MessageStructure()

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