ca.uhn.hl7v2.model.v26.group

Class RGR_RGR_DEFINITION

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v26.group.RGR_RGR_DEFINITION

All Implemented Interfaces:

Group, Structure, Serializable

public class RGR_RGR_DEFINITION
extends AbstractGroup

Represents a RGR_RGR_DEFINITION group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: QRD (Original-Style Query Definition)
• 2: QRF (Original style query filter) optional
• 3: RGR_RGR_PATIENT (a Group object) optional
• 4: RGR_RGR_ORDER (a Group object) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
RGR_RGR_DEFINITION(Group parent, ModelClassFactory factory) Creates a new RGR_RGR_DEFINITION group

Method Summary

Methods

Modifier and Type	Method and Description
RGR_RGR_ORDER	getORDER() Returns the first repetition of ORDER (a Group object) - creates it if necessary
RGR_RGR_ORDER	getORDER(int rep) Returns a specific repetition of ORDER (a Group object) - creates it if necessary
List<RGR_RGR_ORDER>	getORDERAll() Returns a non-modifiable List containing all current existing repetitions of ORDER.
int	getORDERReps() Returns the number of existing repetitions of ORDER
RGR_RGR_PATIENT	getPATIENT() Returns PATIENT (a Group object) - creates it if necessary
QRD	getQRD() Returns QRD (Original-Style Query Definition) - creates it if necessary
QRF	getQRF() Returns QRF (Original style query filter) - creates it if necessary
String	getVersion() Returns "2.6"
RGR_RGR_ORDER	insertORDER(int rep) Inserts a specific repetition of ORDER (a Group object)
void	insertORDER(RGR_RGR_ORDER structure, int rep) Inserts a specific repetition of ORDER (a Group object)
RGR_RGR_ORDER	removeORDER(int rep) Removes a specific repetition of ORDER (a Group object)

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, removeRepetition, tryToInstantiateStructure

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

getMessage, getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Detail

RGR_RGR_DEFINITION

public RGR_RGR_DEFINITION(Group parent,
                  ModelClassFactory factory)

Creates a new RGR_RGR_DEFINITION group

Method Detail

getVersion

public String getVersion()

Returns "2.6"

getQRD

public QRD getQRD()

Returns QRD (Original-Style Query Definition) - creates it if necessary

getQRF

public QRF getQRF()

Returns QRF (Original style query filter) - creates it if necessary

getPATIENT

public RGR_RGR_PATIENT getPATIENT()

Returns PATIENT (a Group object) - creates it if necessary

getORDER

public RGR_RGR_ORDER getORDER()

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

getORDER

public RGR_RGR_ORDER getORDER(int rep)

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

getORDERReps

public int getORDERReps()

Returns the number of existing repetitions of ORDER

getORDERAll

public List<RGR_RGR_ORDER> getORDERAll()
                                throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER

public void insertORDER(RGR_RGR_ORDER structure,
               int rep)
                 throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORDER

public RGR_RGR_ORDER insertORDER(int rep)
                          throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORDER

public RGR_RGR_ORDER removeORDER(int rep)
                          throws HL7Exception

Removes a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)