ca.uhn.hl7v2.model.v24.segment
Class VTQ

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.VTQ

All Implemented Interfaces:

Segment, Structure, Serializable

public class VTQ
extends AbstractSegment

Represents an HL7 VTQ message segment (Virtual Table Query Request). This segment has the following fields:

• VTQ-1: Query Tag (ST) optional
• VTQ-2: Query/Response Format Code (ID)
• VTQ-3: VT Query Name (CE)
• VTQ-4: Virtual Table Name (CE)
• VTQ-5: Selection Criteria (QSC) optional repeating

See Also:

Serialized Form

Constructor Summary

VTQ(Group parent, ModelClassFactory factory)
Creates a new VTQ segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
ID	getQueryResponseFormatCode() Returns VTQ-2: "Query/Response Format Code" - creates it if necessary
ST	getQueryTag() Returns VTQ-1: "Query Tag" - creates it if necessary
QSC[]	getSelectionCriteria() Returns all repetitions of Selection Criteria (VTQ-5).
QSC	getSelectionCriteria(int rep) Returns a specific repetition of VTQ-5: "Selection Criteria" - creates it if necessary
int	getSelectionCriteriaReps() Returns a count of the current number of repetitions of Selection Criteria (VTQ-5).
CE	getVirtualTableName() Returns VTQ-4: "Virtual Table Name" - creates it if necessary
ST	getVtq1_QueryTag() Returns VTQ-1: "Query Tag" - creates it if necessary
ID	getVtq2_QueryResponseFormatCode() Returns VTQ-2: "Query/Response Format Code" - creates it if necessary
CE	getVtq3_VTQueryName() Returns VTQ-3: "VT Query Name" - creates it if necessary
CE	getVtq4_VirtualTableName() Returns VTQ-4: "Virtual Table Name" - creates it if necessary
QSC	getVtq5_SelectionCriteria(int rep) Returns a specific repetition of VTQ-5: "Selection Criteria" - creates it if necessary
int	getVtq5_SelectionCriteriaReps() Returns a count of the current number of repetitions of Selection Criteria (VTQ-5).
CE	getVTQueryName() Returns VTQ-3: "VT Query Name" - creates it if necessary
QSC	insertSelectionCriteria(int rep) Inserts a repetition of VTQ-5: "Selection Criteria" at a specific index
QSC	insertVtq5_SelectionCriteria(int rep) Inserts a repetition of VTQ-5: "Selection Criteria" at a specific index
QSC	removeSelectionCriteria(int rep) Removes a repetition of VTQ-5: "Selection Criteria" at a specific index
QSC	removeVtq5_SelectionCriteria(int rep) Removes a repetition of VTQ-5: "Selection Criteria" at a specific index

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

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

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

Constructor Detail

VTQ

public VTQ(Group parent,
           ModelClassFactory factory)

Creates a new VTQ segment

Method Detail

getQueryTag

public ST getQueryTag()

Returns VTQ-1: "Query Tag" - creates it if necessary

getVtq1_QueryTag

public ST getVtq1_QueryTag()

Returns VTQ-1: "Query Tag" - creates it if necessary

getQueryResponseFormatCode

public ID getQueryResponseFormatCode()

Returns VTQ-2: "Query/Response Format Code" - creates it if necessary

getVtq2_QueryResponseFormatCode

public ID getVtq2_QueryResponseFormatCode()

Returns VTQ-2: "Query/Response Format Code" - creates it if necessary

getVTQueryName

public CE getVTQueryName()

Returns VTQ-3: "VT Query Name" - creates it if necessary

getVtq3_VTQueryName

public CE getVtq3_VTQueryName()

Returns VTQ-3: "VT Query Name" - creates it if necessary

getVirtualTableName

public CE getVirtualTableName()

Returns VTQ-4: "Virtual Table Name" - creates it if necessary

getVtq4_VirtualTableName

public CE getVtq4_VirtualTableName()

Returns VTQ-4: "Virtual Table Name" - creates it if necessary

getSelectionCriteria

public QSC[] getSelectionCriteria()

Returns all repetitions of Selection Criteria (VTQ-5).

getSelectionCriteriaReps

public int getSelectionCriteriaReps()

Returns a count of the current number of repetitions of Selection Criteria (VTQ-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getSelectionCriteria

public QSC getSelectionCriteria(int rep)

Returns a specific repetition of VTQ-5: "Selection Criteria" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getVtq5_SelectionCriteria

public QSC getVtq5_SelectionCriteria(int rep)

Returns a specific repetition of VTQ-5: "Selection Criteria" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getVtq5_SelectionCriteriaReps

public int getVtq5_SelectionCriteriaReps()

Returns a count of the current number of repetitions of Selection Criteria (VTQ-5). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertSelectionCriteria

public QSC insertSelectionCriteria(int rep)
                            throws HL7Exception

Inserts a repetition of VTQ-5: "Selection Criteria" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertVtq5_SelectionCriteria

public QSC insertVtq5_SelectionCriteria(int rep)
                                 throws HL7Exception

Inserts a repetition of VTQ-5: "Selection Criteria" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeSelectionCriteria

public QSC removeSelectionCriteria(int rep)
                            throws HL7Exception

Removes a repetition of VTQ-5: "Selection Criteria" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeVtq5_SelectionCriteria

public QSC removeVtq5_SelectionCriteria(int rep)
                                 throws HL7Exception

Removes a repetition of VTQ-5: "Selection Criteria" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment