ca.uhn.hl7v2.model.v231.group

Class MFN_M06_MFECM0CM1CM2

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.MFN_M06_MFECM0CM1CM2

All Implemented Interfaces:

Group, Structure, Serializable

public class MFN_M06_MFECM0CM1CM2
extends AbstractGroup

Represents a MFN_M06_MFECM0CM1CM2 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: MFE (MFE - master file entry segment)
• 2: CM0 (CM0 - clinical study master segment)
• 3: MFN_M06_CM1CM2 (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
MFN_M06_MFECM0CM1CM2(Group parent, ModelClassFactory factory) Creates a new MFN_M06_MFECM0CM1CM2 group

Method Summary

Methods

Modifier and Type	Method and Description
CM0	getCM0() Returns CM0 (CM0 - clinical study master segment) - creates it if necessary
MFN_M06_CM1CM2	getCM1CM2() Returns the first repetition of CM1CM2 (a Group object) - creates it if necessary
MFN_M06_CM1CM2	getCM1CM2(int rep) Returns a specific repetition of CM1CM2 (a Group object) - creates it if necessary
List<MFN_M06_CM1CM2>	getCM1CM2All() Returns a non-modifiable List containing all current existing repetitions of CM1CM2.
int	getCM1CM2Reps() Returns the number of existing repetitions of CM1CM2
MFE	getMFE() Returns MFE (MFE - master file entry segment) - creates it if necessary
String	getVersion() Returns "2.3.1"
MFN_M06_CM1CM2	insertCM1CM2(int rep) Inserts a specific repetition of CM1CM2 (a Group object)
void	insertCM1CM2(MFN_M06_CM1CM2 structure, int rep) Inserts a specific repetition of CM1CM2 (a Group object)
MFN_M06_CM1CM2	removeCM1CM2(int rep) Removes a specific repetition of CM1CM2 (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

MFN_M06_MFECM0CM1CM2

public MFN_M06_MFECM0CM1CM2(Group parent,
                    ModelClassFactory factory)

Creates a new MFN_M06_MFECM0CM1CM2 group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getMFE

public MFE getMFE()

Returns MFE (MFE - master file entry segment) - creates it if necessary

getCM0

public CM0 getCM0()

Returns CM0 (CM0 - clinical study master segment) - creates it if necessary

getCM1CM2

public MFN_M06_CM1CM2 getCM1CM2()

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

getCM1CM2

public MFN_M06_CM1CM2 getCM1CM2(int rep)

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

getCM1CM2Reps

public int getCM1CM2Reps()

Returns the number of existing repetitions of CM1CM2

getCM1CM2All

public List<MFN_M06_CM1CM2> getCM1CM2All()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertCM1CM2

public void insertCM1CM2(MFN_M06_CM1CM2 structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of CM1CM2 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCM1CM2

public MFN_M06_CM1CM2 insertCM1CM2(int rep)
                            throws HL7Exception

Inserts a specific repetition of CM1CM2 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCM1CM2

public MFN_M06_CM1CM2 removeCM1CM2(int rep)
                            throws HL7Exception

Removes a specific repetition of CM1CM2 (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)