ca.uhn.hl7v2.model.v26.message

Class RSP_E03

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v26.message.RSP_E03

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class RSP_E03
extends AbstractMessage

Represents a RSP_E03 message structure (see chapter 16.3.4). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: UAC (User Authentication Credential Segment) optional repeating
• 4: MSA (Message Acknowledgment)
• 5: ERR (Error) optional repeating
• 6: QAK (Query Acknowledgment)
• 7: QPD (Query Parameter Definition)
• 8: RSP_E03_INVOICE_PROCESSING_RESULTS_INFO (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
RSP_E03() Creates a new RSP_E03 message with DefaultModelClassFactory.
RSP_E03(ModelClassFactory factory) Creates a new RSP_E03 message with custom ModelClassFactory.

Method Summary

Methods

Modifier and Type	Method and Description
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
RSP_E03_INVOICE_PROCESSING_RESULTS_INFO	getINVOICE_PROCESSING_RESULTS_INFO() Returns the first repetition of INVOICE_PROCESSING_RESULTS_INFO (a Group object) - creates it if necessary
RSP_E03_INVOICE_PROCESSING_RESULTS_INFO	getINVOICE_PROCESSING_RESULTS_INFO(int rep) Returns a specific repetition of INVOICE_PROCESSING_RESULTS_INFO (a Group object) - creates it if necessary
List<RSP_E03_INVOICE_PROCESSING_RESULTS_INFO>	getINVOICE_PROCESSING_RESULTS_INFOAll() Returns a non-modifiable List containing all current existing repetitions of INVOICE_PROCESSING_RESULTS_INFO.
int	getINVOICE_PROCESSING_RESULTS_INFOReps() Returns the number of existing repetitions of INVOICE_PROCESSING_RESULTS_INFO
MSA	getMSA() Returns MSA (Message Acknowledgment) - creates it if necessary
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
QAK	getQAK() Returns QAK (Query Acknowledgment) - creates it if necessary
QPD	getQPD() Returns QPD (Query Parameter Definition) - 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 the first repetition of UAC (User Authentication Credential Segment) - creates it if necessary
UAC	getUAC(int rep) Returns a specific repetition of UAC (User Authentication Credential Segment) - creates it if necessary
List<UAC>	getUACAll() Returns a non-modifiable List containing all current existing repetitions of UAC.
int	getUACReps() Returns the number of existing repetitions of UAC
String	getVersion() Returns "2.6"
void	insertERR(ERR structure, int rep) Inserts a specific repetition of ERR (Error)
ERR	insertERR(int rep) Inserts a specific repetition of ERR (Error)
RSP_E03_INVOICE_PROCESSING_RESULTS_INFO	insertINVOICE_PROCESSING_RESULTS_INFO(int rep) Inserts a specific repetition of INVOICE_PROCESSING_RESULTS_INFO (a Group object)
void	insertINVOICE_PROCESSING_RESULTS_INFO(RSP_E03_INVOICE_PROCESSING_RESULTS_INFO structure, int rep) Inserts a specific repetition of INVOICE_PROCESSING_RESULTS_INFO (a Group object)
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)
UAC	insertUAC(int rep) Inserts a specific repetition of UAC (User Authentication Credential Segment)
void	insertUAC(UAC structure, int rep) Inserts a specific repetition of UAC (User Authentication Credential Segment)
ERR	removeERR(int rep) Removes a specific repetition of ERR (Error)
RSP_E03_INVOICE_PROCESSING_RESULTS_INFO	removeINVOICE_PROCESSING_RESULTS_INFO(int rep) Removes a specific repetition of INVOICE_PROCESSING_RESULTS_INFO (a Group object)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)
UAC	removeUAC(int rep) Removes a specific repetition of UAC (User Authentication Credential 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

RSP_E03

public RSP_E03()

Creates a new RSP_E03 message with DefaultModelClassFactory.

RSP_E03

public RSP_E03(ModelClassFactory factory)

Creates a new RSP_E03 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

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 the first repetition of UAC (User Authentication Credential Segment) - creates it if necessary

getUAC

public UAC getUAC(int rep)

Returns a specific repetition of UAC (User Authentication Credential 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.

getUACReps

public int getUACReps()

Returns the number of existing repetitions of UAC

getUACAll

public List<UAC> getUACAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertUAC

public void insertUAC(UAC structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of UAC (User Authentication Credential Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertUAC

public UAC insertUAC(int rep)
              throws HL7Exception

Inserts a specific repetition of UAC (User Authentication Credential Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeUAC

public UAC removeUAC(int rep)
              throws HL7Exception

Removes a specific repetition of UAC (User Authentication Credential Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

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)

getQAK

public QAK getQAK()

Returns QAK (Query Acknowledgment) - creates it if necessary

getQPD

public QPD getQPD()

Returns QPD (Query Parameter Definition) - creates it if necessary

getINVOICE_PROCESSING_RESULTS_INFO

public RSP_E03_INVOICE_PROCESSING_RESULTS_INFO getINVOICE_PROCESSING_RESULTS_INFO()

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

getINVOICE_PROCESSING_RESULTS_INFO

public RSP_E03_INVOICE_PROCESSING_RESULTS_INFO getINVOICE_PROCESSING_RESULTS_INFO(int rep)

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

getINVOICE_PROCESSING_RESULTS_INFOReps

public int getINVOICE_PROCESSING_RESULTS_INFOReps()

Returns the number of existing repetitions of INVOICE_PROCESSING_RESULTS_INFO

getINVOICE_PROCESSING_RESULTS_INFOAll

public List<RSP_E03_INVOICE_PROCESSING_RESULTS_INFO> getINVOICE_PROCESSING_RESULTS_INFOAll()
                                                                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertINVOICE_PROCESSING_RESULTS_INFO

public void insertINVOICE_PROCESSING_RESULTS_INFO(RSP_E03_INVOICE_PROCESSING_RESULTS_INFO structure,
                                         int rep)
                                           throws HL7Exception

Inserts a specific repetition of INVOICE_PROCESSING_RESULTS_INFO (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertINVOICE_PROCESSING_RESULTS_INFO

public RSP_E03_INVOICE_PROCESSING_RESULTS_INFO insertINVOICE_PROCESSING_RESULTS_INFO(int rep)
                                                                              throws HL7Exception

Inserts a specific repetition of INVOICE_PROCESSING_RESULTS_INFO (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeINVOICE_PROCESSING_RESULTS_INFO

public RSP_E03_INVOICE_PROCESSING_RESULTS_INFO removeINVOICE_PROCESSING_RESULTS_INFO(int rep)
                                                                              throws HL7Exception

Removes a specific repetition of INVOICE_PROCESSING_RESULTS_INFO (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)