ca.uhn.hl7v2.model.v231.group

Class RPI_I04_GT1IN1IN2IN3

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.RPI_I04_GT1IN1IN2IN3

All Implemented Interfaces:

Group, Structure, Serializable

public class RPI_I04_GT1IN1IN2IN3
extends AbstractGroup

Represents a RPI_I04_GT1IN1IN2IN3 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: GT1 (GT1 - guarantor segment) optional repeating
• 2: RPI_I04_IN1IN2IN3 (a Group object) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
GT1	getGT1() Returns the first repetition of GT1 (GT1 - guarantor segment) - creates it if necessary
GT1	getGT1(int rep) Returns a specific repetition of GT1 (GT1 - guarantor segment) - creates it if necessary
List<GT1>	getGT1All() Returns a non-modifiable List containing all current existing repetitions of GT1.
int	getGT1Reps() Returns the number of existing repetitions of GT1
RPI_I04_IN1IN2IN3	getIN1IN2IN3() Returns the first repetition of IN1IN2IN3 (a Group object) - creates it if necessary
RPI_I04_IN1IN2IN3	getIN1IN2IN3(int rep) Returns a specific repetition of IN1IN2IN3 (a Group object) - creates it if necessary
List<RPI_I04_IN1IN2IN3>	getIN1IN2IN3All() Returns a non-modifiable List containing all current existing repetitions of IN1IN2IN3.
int	getIN1IN2IN3Reps() Returns the number of existing repetitions of IN1IN2IN3
String	getVersion() Returns "2.3.1"
void	insertGT1(GT1 structure, int rep) Inserts a specific repetition of GT1 (GT1 - guarantor segment)
GT1	insertGT1(int rep) Inserts a specific repetition of GT1 (GT1 - guarantor segment)
RPI_I04_IN1IN2IN3	insertIN1IN2IN3(int rep) Inserts a specific repetition of IN1IN2IN3 (a Group object)
void	insertIN1IN2IN3(RPI_I04_IN1IN2IN3 structure, int rep) Inserts a specific repetition of IN1IN2IN3 (a Group object)
GT1	removeGT1(int rep) Removes a specific repetition of GT1 (GT1 - guarantor segment)
RPI_I04_IN1IN2IN3	removeIN1IN2IN3(int rep) Removes a specific repetition of IN1IN2IN3 (a Group object)

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

RPI_I04_GT1IN1IN2IN3

public RPI_I04_GT1IN1IN2IN3(Group parent,
                    ModelClassFactory factory)

Creates a new RPI_I04_GT1IN1IN2IN3 group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getGT1

public GT1 getGT1()

Returns the first repetition of GT1 (GT1 - guarantor segment) - creates it if necessary

getGT1

public GT1 getGT1(int rep)

Returns a specific repetition of GT1 (GT1 - guarantor segment) - 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.

getGT1Reps

public int getGT1Reps()

Returns the number of existing repetitions of GT1

getGT1All

public List<GT1> getGT1All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertGT1

public void insertGT1(GT1 structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of GT1 (GT1 - guarantor segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertGT1

public GT1 insertGT1(int rep)
              throws HL7Exception

Inserts a specific repetition of GT1 (GT1 - guarantor segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeGT1

public GT1 removeGT1(int rep)
              throws HL7Exception

Removes a specific repetition of GT1 (GT1 - guarantor segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getIN1IN2IN3

public RPI_I04_IN1IN2IN3 getIN1IN2IN3()

Returns the first repetition of IN1IN2IN3 (a Group object) - creates it if necessary

getIN1IN2IN3

public RPI_I04_IN1IN2IN3 getIN1IN2IN3(int rep)

Returns a specific repetition of IN1IN2IN3 (a Group object) - 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.

getIN1IN2IN3Reps

public int getIN1IN2IN3Reps()

Returns the number of existing repetitions of IN1IN2IN3

getIN1IN2IN3All

public List<RPI_I04_IN1IN2IN3> getIN1IN2IN3All()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertIN1IN2IN3

public void insertIN1IN2IN3(RPI_I04_IN1IN2IN3 structure,
                   int rep)
                     throws HL7Exception

Inserts a specific repetition of IN1IN2IN3 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertIN1IN2IN3

public RPI_I04_IN1IN2IN3 insertIN1IN2IN3(int rep)
                                  throws HL7Exception

Inserts a specific repetition of IN1IN2IN3 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeIN1IN2IN3

public RPI_I04_IN1IN2IN3 removeIN1IN2IN3(int rep)
                                  throws HL7Exception

Removes a specific repetition of IN1IN2IN3 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)