ca.uhn.hl7v2.model.v231.message

Class RPL_I02

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.RPL_I02

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RPL_I02
extends AbstractMessage

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

• 1: MSH (MSH - message header segment)
• 2: MSA (MSA - message acknowledgment segment)
• 3: RPL_I02_PRDCTD (a Group object) repeating
• 4: NTE (NTE - notes and comments segment) optional repeating
• 5: DSP (DSP - display data segment) optional repeating
• 6: DSC (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 and Description
RPL_I02() Creates a new RPL_I02 message with DefaultModelClassFactory.
RPL_I02(ModelClassFactory factory) Creates a new RPL_I02 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
DSC	getDSC() Returns DSC (DSC - Continuation pointer segment) - creates it if necessary
DSP	getDSP() Returns the first repetition of DSP (DSP - display data segment) - creates it if necessary
DSP	getDSP(int rep) Returns a specific repetition of DSP (DSP - display data segment) - creates it if necessary
List<DSP>	getDSPAll() Returns a non-modifiable List containing all current existing repetitions of DSP.
int	getDSPReps() Returns the number of existing repetitions of DSP
MSA	getMSA() Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (NTE - notes and comments segment) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
RPL_I02_PRDCTD	getPRDCTD() Returns the first repetition of PRDCTD (a Group object) - creates it if necessary
RPL_I02_PRDCTD	getPRDCTD(int rep) Returns a specific repetition of PRDCTD (a Group object) - creates it if necessary
List<RPL_I02_PRDCTD>	getPRDCTDAll() Returns a non-modifiable List containing all current existing repetitions of PRDCTD.
int	getPRDCTDReps() Returns the number of existing repetitions of PRDCTD
String	getVersion() Returns "2.3.1"
void	insertDSP(DSP structure, int rep) Inserts a specific repetition of DSP (DSP - display data segment)
DSP	insertDSP(int rep) Inserts a specific repetition of DSP (DSP - display data segment)
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
RPL_I02_PRDCTD	insertPRDCTD(int rep) Inserts a specific repetition of PRDCTD (a Group object)
void	insertPRDCTD(RPL_I02_PRDCTD structure, int rep) Inserts a specific repetition of PRDCTD (a Group object)
DSP	removeDSP(int rep) Removes a specific repetition of DSP (DSP - display data segment)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (NTE - notes and comments segment)
RPL_I02_PRDCTD	removePRDCTD(int rep) Removes a specific repetition of PRDCTD (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

RPL_I02

public RPL_I02()

Creates a new RPL_I02 message with DefaultModelClassFactory.

RPL_I02

public RPL_I02(ModelClassFactory factory)

Creates a new RPL_I02 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

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

getMSA

public MSA getMSA()

Returns MSA (MSA - message acknowledgment segment) - creates it if necessary

getPRDCTD

public RPL_I02_PRDCTD getPRDCTD()

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

getPRDCTD

public RPL_I02_PRDCTD getPRDCTD(int rep)

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

getPRDCTDReps

public int getPRDCTDReps()

Returns the number of existing repetitions of PRDCTD

getPRDCTDAll

public List<RPL_I02_PRDCTD> getPRDCTDAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertPRDCTD

public void insertPRDCTD(RPL_I02_PRDCTD structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of PRDCTD (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRDCTD

public RPL_I02_PRDCTD insertPRDCTD(int rep)
                            throws HL7Exception

Inserts a specific repetition of PRDCTD (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRDCTD

public RPL_I02_PRDCTD removePRDCTD(int rep)
                            throws HL7Exception

Removes a specific repetition of PRDCTD (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getNTE

public NTE getNTE()

Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (NTE - notes and comments 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (NTE - notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getDSP

public DSP getDSP()

Returns the first repetition of DSP (DSP - display data segment) - creates it if necessary

getDSP

public DSP getDSP(int rep)

Returns a specific repetition of DSP (DSP - display data 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.

getDSPReps

public int getDSPReps()

Returns the number of existing repetitions of DSP

getDSPAll

public List<DSP> getDSPAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertDSP

public void insertDSP(DSP structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of DSP (DSP - display data segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertDSP

public DSP insertDSP(int rep)
              throws HL7Exception

Inserts a specific repetition of DSP (DSP - display data segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeDSP

public DSP removeDSP(int rep)
              throws HL7Exception

Removes a specific repetition of DSP (DSP - display data segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getDSC

public DSC getDSC()

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