ca.uhn.hl7v2.model.v251.group

Class BPS_O29_TIMING

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.BPS_O29_TIMING

All Implemented Interfaces:

Group, Structure, Serializable

public class BPS_O29_TIMING
extends AbstractGroup

Represents a BPS_O29_TIMING group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: TQ1 (Timing/Quantity)
• 2: TQ2 (Timing/Quantity Relationship) optional repeating

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor and Description
BPS_O29_TIMING(Group parent, ModelClassFactory factory) Creates a new BPS_O29_TIMING group

Method Summary

Methods

Modifier and Type	Method and Description
TQ1	getTQ1() Returns TQ1 (Timing/Quantity) - creates it if necessary
TQ2	getTQ2() Returns the first repetition of TQ2 (Timing/Quantity Relationship) - creates it if necessary
TQ2	getTQ2(int rep) Returns a specific repetition of TQ2 (Timing/Quantity Relationship) - creates it if necessary
List<TQ2>	getTQ2All() Returns a non-modifiable List containing all current existing repetitions of TQ2.
int	getTQ2Reps() Returns the number of existing repetitions of TQ2
String	getVersion() Returns "2.5.1"
TQ2	insertTQ2(int rep) Inserts a specific repetition of TQ2 (Timing/Quantity Relationship)
void	insertTQ2(TQ2 structure, int rep) Inserts a specific repetition of TQ2 (Timing/Quantity Relationship)
TQ2	removeTQ2(int rep) Removes a specific repetition of TQ2 (Timing/Quantity Relationship)

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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

getMessage, getParent

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.Structure

getMessage, getParent

Constructor Detail

BPS_O29_TIMING

public BPS_O29_TIMING(Group parent,
              ModelClassFactory factory)

Creates a new BPS_O29_TIMING group

Method Detail

getVersion

public String getVersion()

Returns "2.5.1"

getTQ1

public TQ1 getTQ1()

Returns TQ1 (Timing/Quantity) - creates it if necessary

getTQ2

public TQ2 getTQ2()

Returns the first repetition of TQ2 (Timing/Quantity Relationship) - creates it if necessary

getTQ2

public TQ2 getTQ2(int rep)

Returns a specific repetition of TQ2 (Timing/Quantity Relationship) - creates it if necessary

Parameters:

rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)

Throws:

HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

getTQ2Reps

public int getTQ2Reps()

Returns the number of existing repetitions of TQ2

getTQ2All

public List<TQ2> getTQ2All()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of TQ2.

Note that unlike getTQ2(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertTQ2

public void insertTQ2(TQ2 structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of TQ2 (Timing/Quantity Relationship)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertTQ2

public TQ2 insertTQ2(int rep)
              throws HL7Exception

Inserts a specific repetition of TQ2 (Timing/Quantity Relationship)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeTQ2

public TQ2 removeTQ2(int rep)
              throws HL7Exception

Removes a specific repetition of TQ2 (Timing/Quantity Relationship)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)