ca.uhn.hl7v2.model.v231.message

Class SQR_S25

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v231.message.SQR_S25

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class SQR_S25
extends AbstractMessage

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

• 1: MSH (MSH - message header segment)
• 2: MSA (MSA - message acknowledgment segment)
• 3: ERR (ERR - error segment) optional
• 4: QAK (Query Acknowledgement)
• 5: SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object) 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
SQR_S25() Creates a new SQR_S25 message with DefaultModelClassFactory.
SQR_S25(ModelClassFactory factory) Creates a new SQR_S25 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
ERR	getERR() Returns ERR (ERR - error segment) - creates it if necessary
MSA	getMSA() Returns MSA (MSA - message acknowledgment segment) - creates it if necessary
MSH	getMSH() Returns MSH (MSH - message header segment) - creates it if necessary
QAK	getQAK() Returns QAK (Query Acknowledgement) - creates it if necessary
SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE	getSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE() Returns the first repetition of SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object) - creates it if necessary
SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE	getSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE(int rep) Returns a specific repetition of SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object) - creates it if necessary
List<SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE>	getSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTEAll() Returns a non-modifiable List containing all current existing repetitions of SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE.
int	getSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTEReps() Returns the number of existing repetitions of SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE
String	getVersion() Returns "2.3.1"
SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE	insertSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE(int rep) Inserts a specific repetition of SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object)
void	insertSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE(SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE structure, int rep) Inserts a specific repetition of SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object)
SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE	removeSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE(int rep) Removes a specific repetition of SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE (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

SQR_S25

public SQR_S25()

Creates a new SQR_S25 message with DefaultModelClassFactory.

SQR_S25

public SQR_S25(ModelClassFactory factory)

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

getERR

public ERR getERR()

Returns ERR (ERR - error segment) - creates it if necessary

getQAK

public QAK getQAK()

Returns QAK (Query Acknowledgement) - creates it if necessary

getSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE

public SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE getSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE()

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

getSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE

public SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE getSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE(int rep)

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

getSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTEReps

public int getSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTEReps()

Returns the number of existing repetitions of SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE

getSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTEAll

public List<SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE> getSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTEAll()
                                                                                                                throws HL7Exception

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

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

Throws:

HL7Exception

insertSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE

public void insertSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE(SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE structure,
                                                       int rep)
                                                         throws HL7Exception

Inserts a specific repetition of SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE

public SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE insertSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE(int rep)
                                                                                                          throws HL7Exception

Inserts a specific repetition of SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE

public SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE removeSCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE(int rep)
                                                                                                          throws HL7Exception

Removes a specific repetition of SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)

getDSC

public DSC getDSC()

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