ca.uhn.hl7v2.model.v24.group

Class RAR_RAR_DEFINITION

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.RAR_RAR_DEFINITION

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class RAR_RAR_DEFINITION
extends AbstractGroup

Represents a RAR_RAR_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: RAR_RAR_PATIENT (a Group object) optional
• 4: RAR_RAR_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
RAR_RAR_DEFINITION(Group parent, ModelClassFactory factory) Creates a new RAR_RAR_DEFINITION group

Method Summary

Modifier and Type	Method and Description
RAR_RAR_ORDER	getORDER() Returns the first repetition of ORDER (a Group object) - creates it if necessary
RAR_RAR_ORDER	getORDER(int rep) Returns a specific repetition of ORDER (a Group object) - creates it if necessary
List<RAR_RAR_ORDER>	getORDERAll() Returns a non-modifiable List containing all current existing repetitions of ORDER.
int	getORDERReps() Returns the number of existing repetitions of ORDER
RAR_RAR_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.4"
RAR_RAR_ORDER	insertORDER(int rep) Inserts a specific repetition of ORDER (a Group object)
void	insertORDER(RAR_RAR_ORDER structure, int rep) Inserts a specific repetition of ORDER (a Group object)
RAR_RAR_ORDER	removeORDER(int rep) Removes a specific repetition of ORDER (a Group object)

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

accept, 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 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

RAR_RAR_DEFINITION

public RAR_RAR_DEFINITION(Group parent,
                          ModelClassFactory factory)

Creates a new RAR_RAR_DEFINITION group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

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 RAR_RAR_PATIENT getPATIENT()

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

getORDER

public RAR_RAR_ORDER getORDER()

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

getORDER

public RAR_RAR_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<RAR_RAR_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(RAR_RAR_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 RAR_RAR_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 RAR_RAR_ORDER removeORDER(int rep)
                          throws HL7Exception

Removes a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)