ca.uhn.hl7v2.model.v26.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.v26.message.RAR_RAR

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RAR_RAR
extends AbstractMessage

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

• 1: MSH (Message Header)
• 2: MSA (Message Acknowledgment)
• 3: ERR (Error) optional repeating
• 4: SFT (Software Segment) optional repeating
• 5: UAC (User Authentication Credential Segment) optional
• 6: RAR_RAR_DEFINITION (a Group object) repeating
• 7: 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
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

Methods

Modifier and Type	Method and 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) - creates it if necessary
ERR	getERR() Returns the first repetition of ERR (Error) - creates it if necessary
ERR	getERR(int rep) Returns a specific repetition of ERR (Error) - creates it if necessary
List<ERR>	getERRAll() Returns a non-modifiable List containing all current existing repetitions of ERR.
int	getERRReps() Returns the number of existing repetitions of ERR
MSA	getMSA() Returns MSA (Message Acknowledgment) - creates it if necessary
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
SFT	getSFT() Returns the first repetition of SFT (Software Segment) - creates it if necessary
SFT	getSFT(int rep) Returns a specific repetition of SFT (Software Segment) - creates it if necessary
List<SFT>	getSFTAll() Returns a non-modifiable List containing all current existing repetitions of SFT.
int	getSFTReps() Returns the number of existing repetitions of SFT
UAC	getUAC() Returns UAC (User Authentication Credential Segment) - creates it if necessary
String	getVersion() Returns "2.6"
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)
void	insertERR(ERR structure, int rep) Inserts a specific repetition of ERR (Error)
ERR	insertERR(int rep) Inserts a specific repetition of ERR (Error)
SFT	insertSFT(int rep) Inserts a specific repetition of SFT (Software Segment)
void	insertSFT(SFT structure, int rep) Inserts a specific repetition of SFT (Software Segment)
RAR_RAR_DEFINITION	removeDEFINITION(int rep) Removes a specific repetition of DEFINITION (a Group object)
ERR	removeERR(int rep) Removes a specific repetition of ERR (Error)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)

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

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 Detail

getVersion

public String getVersion()

Returns "2.6"

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 the first repetition of ERR (Error) - creates it if necessary

getERR

public ERR getERR(int rep)

Returns a specific repetition of ERR (Error) - 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.

getERRReps

public int getERRReps()

Returns the number of existing repetitions of ERR

getERRAll

public List<ERR> getERRAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertERR

public void insertERR(ERR structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of ERR (Error)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertERR

public ERR insertERR(int rep)
              throws HL7Exception

Inserts a specific repetition of ERR (Error)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeERR

public ERR removeERR(int rep)
              throws HL7Exception

Removes a specific repetition of ERR (Error)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getSFT

public SFT getSFT()

Returns the first repetition of SFT (Software Segment) - creates it if necessary

getSFT

public SFT getSFT(int rep)

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

getSFTReps

public int getSFTReps()

Returns the number of existing repetitions of SFT

getSFTAll

public List<SFT> getSFTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSFT

public void insertSFT(SFT structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSFT

public SFT insertSFT(int rep)
              throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSFT

public SFT removeSFT(int rep)
              throws HL7Exception

Removes a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getUAC

public UAC getUAC()

Returns UAC (User Authentication Credential 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) - creates it if necessary