Package ca.uhn.hl7v2.model.v251.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.v251.message.SQR_S25

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class SQR_S25
extends AbstractMessage

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

• 1: MSH (Message Header)
• 2: MSA (Message Acknowledgment)
• 3: ERR (Error) optional repeating
• 4: QAK (Query Acknowledgment)
• 5: SQR_S25_SCHEDULE (a Group object) optional repeating
• 6: DSC (Continuation Pointer) optional

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	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

Modifier and Type	Method	Description
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
QAK	getQAK()	Returns QAK (Query Acknowledgment) - creates it if necessary
SQR_S25_SCHEDULE	getSCHEDULE()	Returns the first repetition of SCHEDULE (a Group object) - creates it if necessary
SQR_S25_SCHEDULE	getSCHEDULE(int rep)	Returns a specific repetition of SCHEDULE (a Group object) - creates it if necessary
List<SQR_S25_SCHEDULE>	getSCHEDULEAll()	Returns a non-modifiable List containing all current existing repetitions of SCHEDULE.
int	getSCHEDULEReps()	Returns the number of existing repetitions of SCHEDULE
String	getVersion()	Returns "2.5.1"
ERR	insertERR(int rep)	Inserts a specific repetition of ERR (Error)
void	insertERR(ERR structure, int rep)	Inserts a specific repetition of ERR (Error)
SQR_S25_SCHEDULE	insertSCHEDULE(int rep)	Inserts a specific repetition of SCHEDULE (a Group object)
void	insertSCHEDULE(SQR_S25_SCHEDULE structure, int rep)	Inserts a specific repetition of SCHEDULE (a Group object)
ERR	removeERR(int rep)	Removes a specific repetition of ERR (Error)
SQR_S25_SCHEDULE	removeSCHEDULE(int rep)	Removes a specific repetition of SCHEDULE (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

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 Details

getVersion

public String getVersion()

Returns "2.5.1"

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)

getQAK

public QAK getQAK()

Returns QAK (Query Acknowledgment) - creates it if necessary

getSCHEDULE

public SQR_S25_SCHEDULE getSCHEDULE()

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

getSCHEDULE

public SQR_S25_SCHEDULE getSCHEDULE(int rep)

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

getSCHEDULEReps

public int getSCHEDULEReps()

Returns the number of existing repetitions of SCHEDULE

getSCHEDULEAll

public List<SQR_S25_SCHEDULE> getSCHEDULEAll()
                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertSCHEDULE

public void insertSCHEDULE(SQR_S25_SCHEDULE structure,
 int rep)
                    throws HL7Exception

Inserts a specific repetition of SCHEDULE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertSCHEDULE

public SQR_S25_SCHEDULE insertSCHEDULE(int rep)
                                throws HL7Exception

Inserts a specific repetition of SCHEDULE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeSCHEDULE

public SQR_S25_SCHEDULE removeSCHEDULE(int rep)
                                throws HL7Exception

Removes a specific repetition of SCHEDULE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getDSC

public DSC getDSC()

Returns DSC (Continuation Pointer) - creates it if necessary