Package ca.uhn.hl7v2.model.v251.group

Class MFN_M07_MF_CLIN_STUDY_SCHED

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v251.group.MFN_M07_MF_CLIN_STUDY_SCHED

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class MFN_M07_MF_CLIN_STUDY_SCHED
extends AbstractGroup

Represents a MFN_M07_MF_CLIN_STUDY_SCHED 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 (Master File Entry)
• 2: CM0 (Clinical Study Master)
• 3: CM2 (Clinical Study Schedule Master) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CM0	getCM0()	Returns CM0 (Clinical Study Master) - creates it if necessary
CM2	getCM2()	Returns the first repetition of CM2 (Clinical Study Schedule Master) - creates it if necessary
CM2	getCM2(int rep)	Returns a specific repetition of CM2 (Clinical Study Schedule Master) - creates it if necessary
List<CM2>	getCM2All()	Returns a non-modifiable List containing all current existing repetitions of CM2.
int	getCM2Reps()	Returns the number of existing repetitions of CM2
MFE	getMFE()	Returns MFE (Master File Entry) - creates it if necessary
String	getVersion()	Returns "2.5.1"
CM2	insertCM2(int rep)	Inserts a specific repetition of CM2 (Clinical Study Schedule Master)
void	insertCM2(CM2 structure, int rep)	Inserts a specific repetition of CM2 (Clinical Study Schedule Master)
CM2	removeCM2(int rep)	Removes a specific repetition of CM2 (Clinical Study Schedule Master)

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 Details

MFN_M07_MF_CLIN_STUDY_SCHED

public MFN_M07_MF_CLIN_STUDY_SCHED(Group parent,
 ModelClassFactory factory)

Creates a new MFN_M07_MF_CLIN_STUDY_SCHED group

Method Details

getVersion

public String getVersion()

Returns "2.5.1"

getMFE

public MFE getMFE()

Returns MFE (Master File Entry) - creates it if necessary

getCM0

public CM0 getCM0()

Returns CM0 (Clinical Study Master) - creates it if necessary

getCM2

public CM2 getCM2()

Returns the first repetition of CM2 (Clinical Study Schedule Master) - creates it if necessary

getCM2

public CM2 getCM2(int rep)

Returns a specific repetition of CM2 (Clinical Study Schedule Master) - 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.

getCM2Reps

public int getCM2Reps()

Returns the number of existing repetitions of CM2

getCM2All

public List<CM2> getCM2All()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertCM2

public void insertCM2(CM2 structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of CM2 (Clinical Study Schedule Master)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertCM2

public CM2 insertCM2(int rep)
              throws HL7Exception

Inserts a specific repetition of CM2 (Clinical Study Schedule Master)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeCM2

public CM2 removeCM2(int rep)
              throws HL7Exception

Removes a specific repetition of CM2 (Clinical Study Schedule Master)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)