ca.uhn.hl7v2.model.v24.message

Class RGR_RGR

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v24.message.RGR_RGR

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RGR_RGR
extends AbstractMessage

Represents a RGR_RGR message structure (see chapter 4). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: MSA (Message Acknowledgment)
• 3: ERR (Error) optional
• 4: RGR_RGR_DEFINTION (a Group object) repeating
• 5: DSC (Continuation Pointer) optional

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
RGR_RGR() Creates a new RGR_RGR message with DefaultModelClassFactory.
RGR_RGR(ModelClassFactory factory) Creates a new RGR_RGR message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
RGR_RGR_DEFINTION	getDEFINTION() Returns the first repetition of DEFINTION (a Group object) - creates it if necessary
RGR_RGR_DEFINTION	getDEFINTION(int rep) Returns a specific repetition of DEFINTION (a Group object) - creates it if necessary
List<RGR_RGR_DEFINTION>	getDEFINTIONAll() Returns a non-modifiable List containing all current existing repetitions of DEFINTION.
int	getDEFINTIONReps() Returns the number of existing repetitions of DEFINTION
DSC	getDSC() Returns DSC (Continuation Pointer) - creates it if necessary
ERR	getERR() Returns ERR (Error) - creates it if necessary
MSA	getMSA() Returns MSA (Message Acknowledgment) - creates it if necessary
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
String	getVersion() Returns "2.4"
RGR_RGR_DEFINTION	insertDEFINTION(int rep) Inserts a specific repetition of DEFINTION (a Group object)
void	insertDEFINTION(RGR_RGR_DEFINTION structure, int rep) Inserts a specific repetition of DEFINTION (a Group object)
RGR_RGR_DEFINTION	removeDEFINTION(int rep) Removes a specific repetition of DEFINTION (a Group object)

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

encode, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, setParser, setValidationContext, toString

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 java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Group

addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getName

Constructor Detail

RGR_RGR

public RGR_RGR()

Creates a new RGR_RGR message with DefaultModelClassFactory.

RGR_RGR

public RGR_RGR(ModelClassFactory factory)

Creates a new RGR_RGR message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.4"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getMSA

public MSA getMSA()

Returns MSA (Message Acknowledgment) - creates it if necessary

getERR

public ERR getERR()

Returns ERR (Error) - creates it if necessary

getDEFINTION

public RGR_RGR_DEFINTION getDEFINTION()

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

getDEFINTION

public RGR_RGR_DEFINTION getDEFINTION(int rep)

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

getDEFINTIONReps

public int getDEFINTIONReps()

Returns the number of existing repetitions of DEFINTION

getDEFINTIONAll

public List<RGR_RGR_DEFINTION> getDEFINTIONAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertDEFINTION

public void insertDEFINTION(RGR_RGR_DEFINTION structure,
                   int rep)
                     throws HL7Exception

Inserts a specific repetition of DEFINTION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertDEFINTION

public RGR_RGR_DEFINTION insertDEFINTION(int rep)
                                  throws HL7Exception

Inserts a specific repetition of DEFINTION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeDEFINTION

public RGR_RGR_DEFINTION removeDEFINTION(int rep)
                                  throws HL7Exception

Removes a specific repetition of DEFINTION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (Continuation Pointer) - creates it if necessary