ca.uhn.hl7v2.model.v23.group

Class RGV_O01_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.RGV_O01_ORDER

All Implemented Interfaces:

Group, Structure, Serializable

public class RGV_O01_ORDER
extends AbstractGroup

Represents a RGV_O01_ORDER 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: ORC (Common order segment)
• 2: RGV_O01_ORDER_DETAIL (a Group object) optional
• 3: RGV_O01_ENCODING (a Group object) optional
• 4: RGV_O01_GIVE (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
RGV_O01_ORDER(Group parent, ModelClassFactory factory) Creates a new RGV_O01_ORDER group

Method Summary

Methods

Modifier and Type	Method and Description
RGV_O01_ENCODING	getENCODING() Returns ENCODING (a Group object) - creates it if necessary
RGV_O01_GIVE	getGIVE() Returns the first repetition of GIVE (a Group object) - creates it if necessary
RGV_O01_GIVE	getGIVE(int rep) Returns a specific repetition of GIVE (a Group object) - creates it if necessary
List<RGV_O01_GIVE>	getGIVEAll() Returns a non-modifiable List containing all current existing repetitions of GIVE.
int	getGIVEReps() Returns the number of existing repetitions of GIVE
ORC	getORC() Returns ORC (Common order segment) - creates it if necessary
RGV_O01_ORDER_DETAIL	getORDER_DETAIL() Returns ORDER_DETAIL (a Group object) - creates it if necessary
String	getVersion() Returns "2.3"
RGV_O01_GIVE	insertGIVE(int rep) Inserts a specific repetition of GIVE (a Group object)
void	insertGIVE(RGV_O01_GIVE structure, int rep) Inserts a specific repetition of GIVE (a Group object)
RGV_O01_GIVE	removeGIVE(int rep) Removes a specific repetition of GIVE (a Group object)

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

RGV_O01_ORDER

public RGV_O01_ORDER(Group parent,
             ModelClassFactory factory)

Creates a new RGV_O01_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.3"

getORC

public ORC getORC()

Returns ORC (Common order segment) - creates it if necessary

getORDER_DETAIL

public RGV_O01_ORDER_DETAIL getORDER_DETAIL()

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

getENCODING

public RGV_O01_ENCODING getENCODING()

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

getGIVE

public RGV_O01_GIVE getGIVE()

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

getGIVE

public RGV_O01_GIVE getGIVE(int rep)

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

getGIVEReps

public int getGIVEReps()

Returns the number of existing repetitions of GIVE

getGIVEAll

public List<RGV_O01_GIVE> getGIVEAll()
                              throws HL7Exception

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

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

Throws:

HL7Exception

insertGIVE

public void insertGIVE(RGV_O01_GIVE structure,
              int rep)
                throws HL7Exception

Inserts a specific repetition of GIVE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertGIVE

public RGV_O01_GIVE insertGIVE(int rep)
                        throws HL7Exception

Inserts a specific repetition of GIVE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeGIVE

public RGV_O01_GIVE removeGIVE(int rep)
                        throws HL7Exception

Removes a specific repetition of GIVE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)