ca.uhn.hl7v2.model.v23.group

Class RRA_O02_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.RRA_O02_ORDER

All Implemented Interfaces:

Group, Structure, Serializable

public class RRA_O02_ORDER
extends AbstractGroup

Represents a RRA_O02_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: RRA_O02_ADMINISTRATION (a Group object) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
RRA_O02_ADMINISTRATION	getADMINISTRATION() Returns the first repetition of ADMINISTRATION (a Group object) - creates it if necessary
RRA_O02_ADMINISTRATION	getADMINISTRATION(int rep) Returns a specific repetition of ADMINISTRATION (a Group object) - creates it if necessary
List<RRA_O02_ADMINISTRATION>	getADMINISTRATIONAll() Returns a non-modifiable List containing all current existing repetitions of ADMINISTRATION.
int	getADMINISTRATIONReps() Returns the number of existing repetitions of ADMINISTRATION
ORC	getORC() Returns ORC (Common order segment) - creates it if necessary
String	getVersion() Returns "2.3"
RRA_O02_ADMINISTRATION	insertADMINISTRATION(int rep) Inserts a specific repetition of ADMINISTRATION (a Group object)
void	insertADMINISTRATION(RRA_O02_ADMINISTRATION structure, int rep) Inserts a specific repetition of ADMINISTRATION (a Group object)
RRA_O02_ADMINISTRATION	removeADMINISTRATION(int rep) Removes a specific repetition of ADMINISTRATION (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

RRA_O02_ORDER

public RRA_O02_ORDER(Group parent,
             ModelClassFactory factory)

Creates a new RRA_O02_ORDER group

Method Detail

getVersion

public String getVersion()

Returns "2.3"

getORC

public ORC getORC()

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

getADMINISTRATION

public RRA_O02_ADMINISTRATION getADMINISTRATION()

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

getADMINISTRATION

public RRA_O02_ADMINISTRATION getADMINISTRATION(int rep)

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

getADMINISTRATIONReps

public int getADMINISTRATIONReps()

Returns the number of existing repetitions of ADMINISTRATION

getADMINISTRATIONAll

public List<RRA_O02_ADMINISTRATION> getADMINISTRATIONAll()
                                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertADMINISTRATION

public void insertADMINISTRATION(RRA_O02_ADMINISTRATION structure,
                        int rep)
                          throws HL7Exception

Inserts a specific repetition of ADMINISTRATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertADMINISTRATION

public RRA_O02_ADMINISTRATION insertADMINISTRATION(int rep)
                                            throws HL7Exception

Inserts a specific repetition of ADMINISTRATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeADMINISTRATION

public RRA_O02_ADMINISTRATION removeADMINISTRATION(int rep)
                                            throws HL7Exception

Removes a specific repetition of ADMINISTRATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)