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

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

All Implemented Interfaces:

Composite, Type, Serializable

public class TQ
extends AbstractType
implements Composite

Represents an HL7 TQ (timing quantity) data type. This type consists of the following components:

• quantity (CQ)
• interval (RI)
• duration (ST)
• start date/time (TS)
• end date/time (TS)
• priority (ST)
• condition (ST)
• text (TX) (TX)
• conjunction component (ID)
• order sequencing (OSD)
• occurrence duration (CE)
• total occurences (NM)

See Also:

Serialized Form

Constructor Summary

TQ(Message message)
Creates a new TQ type

Method Summary

Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
ST	getCondition() Returns condition (component #7).
ID	getConjunctionComponent() Returns conjunction component (component #9).
ST	getDuration() Returns duration (component #3).
TS	getEndDateTime() Returns end date/time (component #5).
RI	getInterval() Returns interval (component #2).
CE	getOccurrenceDuration() Returns occurrence duration (component #11).
OSD	getOrderSequencing() Returns order sequencing (component #10).
ST	getPriority() Returns priority (component #6).
CQ	getQuantity() Returns quantity (component #1).
TS	getStartDateTime() Returns start date/time (component #4).
TX	getText() Returns text (TX) (component #8).
NM	getTotalOccurences() Returns total occurences (component #12).
CQ	getTq1_Quantity() Returns quantity (component #1).
OSD	getTq10_OrderSequencing() Returns order sequencing (component #10).
CE	getTq11_OccurrenceDuration() Returns occurrence duration (component #11).
NM	getTq12_TotalOccurences() Returns total occurences (component #12).
RI	getTq2_Interval() Returns interval (component #2).
ST	getTq3_Duration() Returns duration (component #3).
TS	getTq4_StartDateTime() Returns start date/time (component #4).
TS	getTq5_EndDateTime() Returns end date/time (component #5).
ST	getTq6_Priority() Returns priority (component #6).
ST	getTq7_Condition() Returns condition (component #7).
TX	getTq8_Text() Returns text (TX) (component #8).
ID	getTq9_ConjunctionComponent() Returns conjunction component (component #9).

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

TQ

public TQ(Message message)

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

getQuantity

public CQ getQuantity()

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

getTq1_Quantity

public CQ getTq1_Quantity()

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

getInterval

public RI getInterval()

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

getTq2_Interval

public RI getTq2_Interval()

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

getDuration

public ST getDuration()

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

getTq3_Duration

public ST getTq3_Duration()

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

getStartDateTime

public TS getStartDateTime()

Returns start date/time (component #4). This is a convenience method that saves you from casting and handling an exception.

getTq4_StartDateTime

public TS getTq4_StartDateTime()

Returns start date/time (component #4). This is a convenience method that saves you from casting and handling an exception.

getEndDateTime

public TS getEndDateTime()

Returns end date/time (component #5). This is a convenience method that saves you from casting and handling an exception.

getTq5_EndDateTime

public TS getTq5_EndDateTime()

Returns end date/time (component #5). This is a convenience method that saves you from casting and handling an exception.

getPriority

public ST getPriority()

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

getTq6_Priority

public ST getTq6_Priority()

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

getCondition

public ST getCondition()

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

getTq7_Condition

public ST getTq7_Condition()

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

getText

public TX getText()

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

getTq8_Text

public TX getTq8_Text()

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

getConjunctionComponent

public ID getConjunctionComponent()

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

getTq9_ConjunctionComponent

public ID getTq9_ConjunctionComponent()

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

getOrderSequencing

public OSD getOrderSequencing()

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

getTq10_OrderSequencing

public OSD getTq10_OrderSequencing()

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

getOccurrenceDuration

public CE getOccurrenceDuration()

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

getTq11_OccurrenceDuration

public CE getTq11_OccurrenceDuration()

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

getTotalOccurences

public NM getTotalOccurences()

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

getTq12_TotalOccurences

public NM getTq12_TotalOccurences()

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