Package ca.uhn.hl7v2.model.v24.group

Class MFN_M06_MF_CLIN_STUDY

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.MFN_M06_MF_CLIN_STUDY

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class MFN_M06_MF_CLIN_STUDY
extends AbstractGroup

Represents a MFN_M06_MF_CLIN_STUDY 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: MFN_M06_MF_PHASE_SCHED_DETAIL (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	Description
MFN_M06_MF_CLIN_STUDY(Group parent, ModelClassFactory factory)	Creates a new MFN_M06_MF_CLIN_STUDY group

Method Summary

Modifier and Type	Method	Description
CM0	getCM0()	Returns CM0 (Clinical Study Master) - creates it if necessary
MFN_M06_MF_PHASE_SCHED_DETAIL	getMF_PHASE_SCHED_DETAIL()	Returns the first repetition of MF_PHASE_SCHED_DETAIL (a Group object) - creates it if necessary
MFN_M06_MF_PHASE_SCHED_DETAIL	getMF_PHASE_SCHED_DETAIL(int rep)	Returns a specific repetition of MF_PHASE_SCHED_DETAIL (a Group object) - creates it if necessary
List<MFN_M06_MF_PHASE_SCHED_DETAIL>	getMF_PHASE_SCHED_DETAILAll()	Returns a non-modifiable List containing all current existing repetitions of MF_PHASE_SCHED_DETAIL.
int	getMF_PHASE_SCHED_DETAILReps()	Returns the number of existing repetitions of MF_PHASE_SCHED_DETAIL
MFE	getMFE()	Returns MFE (Master File Entry) - creates it if necessary
String	getVersion()	Returns "2.4"
MFN_M06_MF_PHASE_SCHED_DETAIL	insertMF_PHASE_SCHED_DETAIL(int rep)	Inserts a specific repetition of MF_PHASE_SCHED_DETAIL (a Group object)
void	insertMF_PHASE_SCHED_DETAIL(MFN_M06_MF_PHASE_SCHED_DETAIL structure, int rep)	Inserts a specific repetition of MF_PHASE_SCHED_DETAIL (a Group object)
MFN_M06_MF_PHASE_SCHED_DETAIL	removeMF_PHASE_SCHED_DETAIL(int rep)	Removes a specific repetition of MF_PHASE_SCHED_DETAIL (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 Details

MFN_M06_MF_CLIN_STUDY

public MFN_M06_MF_CLIN_STUDY(Group parent,
 ModelClassFactory factory)

Creates a new MFN_M06_MF_CLIN_STUDY group

Method Details

getVersion

public String getVersion()

Returns "2.4"

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

getMF_PHASE_SCHED_DETAIL

public MFN_M06_MF_PHASE_SCHED_DETAIL getMF_PHASE_SCHED_DETAIL()

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

getMF_PHASE_SCHED_DETAIL

public MFN_M06_MF_PHASE_SCHED_DETAIL getMF_PHASE_SCHED_DETAIL(int rep)

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

getMF_PHASE_SCHED_DETAILReps

public int getMF_PHASE_SCHED_DETAILReps()

Returns the number of existing repetitions of MF_PHASE_SCHED_DETAIL

getMF_PHASE_SCHED_DETAILAll

public List<MFN_M06_MF_PHASE_SCHED_DETAIL> getMF_PHASE_SCHED_DETAILAll()
                                                                throws HL7Exception

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

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

Throws:

HL7Exception

insertMF_PHASE_SCHED_DETAIL

public void insertMF_PHASE_SCHED_DETAIL(MFN_M06_MF_PHASE_SCHED_DETAIL structure,
 int rep)
                                 throws HL7Exception

Inserts a specific repetition of MF_PHASE_SCHED_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertMF_PHASE_SCHED_DETAIL

public MFN_M06_MF_PHASE_SCHED_DETAIL insertMF_PHASE_SCHED_DETAIL(int rep)
                                                          throws HL7Exception

Inserts a specific repetition of MF_PHASE_SCHED_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeMF_PHASE_SCHED_DETAIL

public MFN_M06_MF_PHASE_SCHED_DETAIL removeMF_PHASE_SCHED_DETAIL(int rep)
                                                          throws HL7Exception

Removes a specific repetition of MF_PHASE_SCHED_DETAIL (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)