Package ca.uhn.hl7v2.model.v23.message

Class RAR_RAR

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v23.message.RAR_RAR

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class RAR_RAR
extends AbstractMessage

Represents a RAR_RAR message structure (see chapter ?). This structure contains the following elements:

• 1: MSH (Message header segment)
• 2: MSA (Message acknowledgement segment)
• 3: ERR (Error segment) optional
• 4: RAR_RAR_DEFINITION (a Group object) repeating
• 5: DSC (Continuation pointer segment) optional

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RAR_RAR_DEFINITION	getDEFINITION()	Returns the first repetition of DEFINITION (a Group object) - creates it if necessary
RAR_RAR_DEFINITION	getDEFINITION(int rep)	Returns a specific repetition of DEFINITION (a Group object) - creates it if necessary
List<RAR_RAR_DEFINITION>	getDEFINITIONAll()	Returns a non-modifiable List containing all current existing repetitions of DEFINITION.
int	getDEFINITIONReps()	Returns the number of existing repetitions of DEFINITION
DSC	getDSC()	Returns DSC (Continuation pointer segment) - creates it if necessary
ERR	getERR()	Returns ERR (Error segment) - creates it if necessary
MSA	getMSA()	Returns MSA (Message acknowledgement segment) - creates it if necessary
MSH	getMSH()	Returns MSH (Message header segment) - creates it if necessary
String	getVersion()	Returns "2.3"
RAR_RAR_DEFINITION	insertDEFINITION(int rep)	Inserts a specific repetition of DEFINITION (a Group object)
void	insertDEFINITION(RAR_RAR_DEFINITION structure, int rep)	Inserts a specific repetition of DEFINITION (a Group object)
RAR_RAR_DEFINITION	removeDEFINITION(int rep)	Removes a specific repetition of DEFINITION (a Group object)

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

accept, copy, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, toString

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

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 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, isChoiceElement, isGroup, isRepeating, isRequired

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

getName

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

isEmpty, provideLocation

Constructor Details

RAR_RAR

public RAR_RAR()

Creates a new RAR_RAR message with DefaultModelClassFactory.

RAR_RAR

public RAR_RAR(ModelClassFactory factory)

Creates a new RAR_RAR message with custom ModelClassFactory.

Method Details

getVersion

public String getVersion()

Returns "2.3"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message header segment) - creates it if necessary

getMSA

public MSA getMSA()

Returns MSA (Message acknowledgement segment) - creates it if necessary

getERR

public ERR getERR()

Returns ERR (Error segment) - creates it if necessary

getDEFINITION

public RAR_RAR_DEFINITION getDEFINITION()

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

getDEFINITION

public RAR_RAR_DEFINITION getDEFINITION(int rep)

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

getDEFINITIONReps

public int getDEFINITIONReps()

Returns the number of existing repetitions of DEFINITION

getDEFINITIONAll

public List<RAR_RAR_DEFINITION> getDEFINITIONAll()
                                          throws HL7Exception

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

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

Throws:

HL7Exception

insertDEFINITION

public void insertDEFINITION(RAR_RAR_DEFINITION structure,
 int rep)
                      throws HL7Exception

Inserts a specific repetition of DEFINITION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertDEFINITION

public RAR_RAR_DEFINITION insertDEFINITION(int rep)
                                    throws HL7Exception

Inserts a specific repetition of DEFINITION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeDEFINITION

public RAR_RAR_DEFINITION removeDEFINITION(int rep)
                                    throws HL7Exception

Removes a specific repetition of DEFINITION (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (Continuation pointer segment) - creates it if necessary