ca.uhn.hl7v2.model.v231.group

Class DFT_P03_FT1PR1ROL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.DFT_P03_FT1PR1ROL

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class DFT_P03_FT1PR1ROL
extends AbstractGroup

Represents a DFT_P03_FT1PR1ROL 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: FT1 (FT1 - financial transaction segment)
• 2: DFT_P03_PR1ROL (a Group object) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
FT1	getFT1() Returns FT1 (FT1 - financial transaction segment) - creates it if necessary
DFT_P03_PR1ROL	getPR1ROL() Returns the first repetition of PR1ROL (a Group object) - creates it if necessary
DFT_P03_PR1ROL	getPR1ROL(int rep) Returns a specific repetition of PR1ROL (a Group object) - creates it if necessary
List<DFT_P03_PR1ROL>	getPR1ROLAll() Returns a non-modifiable List containing all current existing repetitions of PR1ROL.
int	getPR1ROLReps() Returns the number of existing repetitions of PR1ROL
String	getVersion() Returns "2.3.1"
void	insertPR1ROL(DFT_P03_PR1ROL structure, int rep) Inserts a specific repetition of PR1ROL (a Group object)
DFT_P03_PR1ROL	insertPR1ROL(int rep) Inserts a specific repetition of PR1ROL (a Group object)
DFT_P03_PR1ROL	removePR1ROL(int rep) Removes a specific repetition of PR1ROL (a Group object)

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

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

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

DFT_P03_FT1PR1ROL

public DFT_P03_FT1PR1ROL(Group parent,
                         ModelClassFactory factory)

Creates a new DFT_P03_FT1PR1ROL group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getFT1

public FT1 getFT1()

Returns FT1 (FT1 - financial transaction segment) - creates it if necessary

getPR1ROL

public DFT_P03_PR1ROL getPR1ROL()

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

getPR1ROL

public DFT_P03_PR1ROL getPR1ROL(int rep)

Returns a specific repetition of PR1ROL (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.

getPR1ROLReps

public int getPR1ROLReps()

Returns the number of existing repetitions of PR1ROL

getPR1ROLAll

public List<DFT_P03_PR1ROL> getPR1ROLAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertPR1ROL

public void insertPR1ROL(DFT_P03_PR1ROL structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of PR1ROL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPR1ROL

public DFT_P03_PR1ROL insertPR1ROL(int rep)
                            throws HL7Exception

Inserts a specific repetition of PR1ROL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePR1ROL

public DFT_P03_PR1ROL removePR1ROL(int rep)
                            throws HL7Exception

Removes a specific repetition of PR1ROL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)