001 /*
002 * This class is an auto-generated source file for a HAPI
003 * HL7 v2.x standard structure class.
004 *
005 * For more information, visit: http://hl7api.sourceforge.net/
006 */
007
008 package ca.uhn.hl7v2.model.v24.group;
009
010 import ca.uhn.hl7v2.model.v24.segment.*;
011
012 import ca.uhn.log.HapiLogFactory;
013 import ca.uhn.hl7v2.HL7Exception;
014 import ca.uhn.hl7v2.parser.ModelClassFactory;
015 import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
016 import ca.uhn.hl7v2.model.AbstractMessage;
017 import ca.uhn.hl7v2.model.Group;
018 import ca.uhn.hl7v2.model.AbstractGroup;
019 import ca.uhn.hl7v2.model.GenericSegment;
020
021 /**
022 * <p>Represents a MFN_M07_MF_CLIN_STUDY_SCHED group structure (a Group object).
023 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
024 * This Group contains the following elements:
025 * </p>
026 * <ul>
027 * <li>1: MFE (Master File Entry) <b> </b></li>
028 * <li>2: CM0 (Clinical Study Master) <b> </b></li>
029 * <li>3: CM2 (Clinical Study Schedule Master) <b>optional repeating</b></li>
030 * </ul>
031 */
032 public class MFN_M07_MF_CLIN_STUDY_SCHED extends AbstractGroup {
033
034 /**
035 * Creates a new MFN_M07_MF_CLIN_STUDY_SCHED group
036 */
037 public MFN_M07_MF_CLIN_STUDY_SCHED(Group parent, ModelClassFactory factory) {
038 super(parent, factory);
039 init(factory);
040 }
041
042 private void init(ModelClassFactory factory) {
043 try {
044 this.add(MFE.class, true, false);
045 this.add(CM0.class, true, false);
046 this.add(CM2.class, false, true);
047 } catch(HL7Exception e) {
048 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error creating MFN_M07_MF_CLIN_STUDY_SCHED - this is probably a bug in the source code generator.", e);
049 }
050 }
051
052 /**
053 * Returns "2.4"
054 */
055 public String getVersion() {
056 return "2.4";
057 }
058
059
060
061 /**
062 * Returns
063 * MFE (Master File Entry) - creates it if necessary
064 */
065 public MFE getMFE() {
066 MFE ret = null;
067 try {
068 ret = (MFE)this.get("MFE");
069 } catch(HL7Exception e) {
070 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
071 throw new RuntimeException(e);
072 }
073 return ret;
074 }
075
076
077
078
079 /**
080 * Returns
081 * CM0 (Clinical Study Master) - creates it if necessary
082 */
083 public CM0 getCM0() {
084 CM0 ret = null;
085 try {
086 ret = (CM0)this.get("CM0");
087 } catch(HL7Exception e) {
088 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
089 throw new RuntimeException(e);
090 }
091 return ret;
092 }
093
094
095
096
097 /**
098 * Returns
099 * the first repetition of
100 * CM2 (Clinical Study Schedule Master) - creates it if necessary
101 */
102 public CM2 getCM2() {
103 CM2 ret = null;
104 try {
105 ret = (CM2)this.get("CM2");
106 } catch(HL7Exception e) {
107 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
108 throw new RuntimeException(e);
109 }
110 return ret;
111 }
112
113
114 /**
115 * Returns a specific repetition of
116 * CM2 (Clinical Study Schedule Master) - creates it if necessary
117 *
118 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
119 * @throws HL7Exception if the repetition requested is more than one
120 * greater than the number of existing repetitions.
121 */
122 public CM2 getCM2(int rep) {
123 CM2 ret = null;
124 try {
125 ret = (CM2)this.get("CM2", rep);
126 } catch(HL7Exception e) {
127 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
128 throw new RuntimeException(e);
129 }
130 return ret;
131 }
132
133 /**
134 * Returns the number of existing repetitions of CM2
135 */
136 public int getCM2Reps() {
137 int reps = -1;
138 try {
139 reps = this.getAll("CM2").length;
140 } catch (HL7Exception e) {
141 String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
142 HapiLogFactory.getHapiLog(this.getClass()).error(message, e);
143 throw new RuntimeException(message);
144 }
145 return reps;
146 }
147
148 /**
149 * Inserts a specific repetition of CM2 (Clinical Study Schedule Master)
150 * @see AbstractGroup#insertRepetition(Structure, int)
151 */
152 public void insertCM2(CM2 structure, int rep) throws HL7Exception {
153 super.insertRepetition("CM2", structure, rep);
154 }
155
156
157 /**
158 * Inserts a specific repetition of CM2 (Clinical Study Schedule Master)
159 * @see AbstractGroup#insertRepetition(Structure, int)
160 */
161 public CM2 insertCM2(int rep) throws HL7Exception {
162 return (CM2)super.insertRepetition("CM2", rep);
163 }
164
165
166 /**
167 * Removes a specific repetition of CM2 (Clinical Study Schedule Master)
168 * @see AbstractGroup#removeRepetition(String, int)
169 */
170 public CM2 removeCM2(int rep) throws HL7Exception {
171 return (CM2)super.removeRepetition("CM2", rep);
172 }
173
174
175
176 }
177