ca.uhn.hl7v2.model.v281.group

Class CSU_C09_STUDY_PHARM

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.CSU_C09_STUDY_PHARM

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class CSU_C09_STUDY_PHARM
extends AbstractGroup

Represents a CSU_C09_STUDY_PHARM 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: CSU_C09_COMMON_ORDER (a Group object) optional
• 2: CSU_C09_RX_ADMIN (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
CSU_C09_STUDY_PHARM(Group parent, ModelClassFactory factory) Creates a new CSU_C09_STUDY_PHARM group

Method Summary

Modifier and Type	Method and Description
CSU_C09_COMMON_ORDER	getCOMMON_ORDER() Returns COMMON_ORDER (a Group object) - creates it if necessary
CSU_C09_RX_ADMIN	getRX_ADMIN() Returns the first repetition of RX_ADMIN (a Group object) - creates it if necessary
CSU_C09_RX_ADMIN	getRX_ADMIN(int rep) Returns a specific repetition of RX_ADMIN (a Group object) - creates it if necessary
List<CSU_C09_RX_ADMIN>	getRX_ADMINAll() Returns a non-modifiable List containing all current existing repetitions of RX_ADMIN.
int	getRX_ADMINReps() Returns the number of existing repetitions of RX_ADMIN
String	getVersion() Returns "2.8.1"
void	insertRX_ADMIN(CSU_C09_RX_ADMIN structure, int rep) Inserts a specific repetition of RX_ADMIN (a Group object)
CSU_C09_RX_ADMIN	insertRX_ADMIN(int rep) Inserts a specific repetition of RX_ADMIN (a Group object)
CSU_C09_RX_ADMIN	removeRX_ADMIN(int rep) Removes a specific repetition of RX_ADMIN (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

CSU_C09_STUDY_PHARM

public CSU_C09_STUDY_PHARM(Group parent,
                           ModelClassFactory factory)

Creates a new CSU_C09_STUDY_PHARM group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getCOMMON_ORDER

public CSU_C09_COMMON_ORDER getCOMMON_ORDER()

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

getRX_ADMIN

public CSU_C09_RX_ADMIN getRX_ADMIN()

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

getRX_ADMIN

public CSU_C09_RX_ADMIN getRX_ADMIN(int rep)

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

getRX_ADMINReps

public int getRX_ADMINReps()

Returns the number of existing repetitions of RX_ADMIN

getRX_ADMINAll

public List<CSU_C09_RX_ADMIN> getRX_ADMINAll()
                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertRX_ADMIN

public void insertRX_ADMIN(CSU_C09_RX_ADMIN structure,
                           int rep)
                    throws HL7Exception

Inserts a specific repetition of RX_ADMIN (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRX_ADMIN

public CSU_C09_RX_ADMIN insertRX_ADMIN(int rep)
                                throws HL7Exception

Inserts a specific repetition of RX_ADMIN (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRX_ADMIN

public CSU_C09_RX_ADMIN removeRX_ADMIN(int rep)
                                throws HL7Exception

Removes a specific repetition of RX_ADMIN (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)