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 * The contents of this file are subject to the Mozilla Public License Version 1.1 
008 * (the "License"); you may not use this file except in compliance with the License. 
009 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
010 * Software distributed under the License is distributed on an "AS IS" basis, 
011 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
012 * specific language governing rights and limitations under the License. 
013 * 
014 * The Original Code is "[file_name]".  Description: 
015 * "[one_line_description]" 
016 * 
017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
018 * 2012.  All Rights Reserved. 
019 * 
020 * Contributor(s): ______________________________________. 
021 * 
022 * Alternatively, the contents of this file may be used under the terms of the 
023 * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
024 * applicable instead of those above.  If you wish to allow use of your version of this 
025 * file only under the terms of the GPL and not to allow others to use your version 
026 * of this file under the MPL, indicate your decision by deleting  the provisions above 
027 * and replace  them with the notice and other provisions required by the GPL License.  
028 * If you do not delete the provisions above, a recipient may use your version of 
029 * this file under either the MPL or the GPL. 
030 * 
031 */
032
033
034package ca.uhn.hl7v2.model.v231.group;
035
036import ca.uhn.hl7v2.model.v231.segment.*;
037
038import java.util.List;
039
040import ca.uhn.hl7v2.HL7Exception;
041import ca.uhn.hl7v2.parser.ModelClassFactory;
042import ca.uhn.hl7v2.model.*;
043
044/**
045 * <p>Represents a PEX_P07_CSRCSP group structure (a Group object).
046 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
047 * This Group contains the following elements:  
048 * </p>
049 * <ul>
050                 * <li>1: CSR (CSR - clinical study registration segment) <b> </b></li>
051                 * <li>2: CSP (CSP - clinical study phase segment) <b>optional repeating</b></li>
052 * </ul>
053 */
054@SuppressWarnings("unused")
055public class PEX_P07_CSRCSP extends AbstractGroup {
056
057    /** 
058     * Creates a new PEX_P07_CSRCSP group
059     */
060    public PEX_P07_CSRCSP(Group parent, ModelClassFactory factory) {
061       super(parent, factory);
062       init(factory);
063    }
064
065    private void init(ModelClassFactory factory) {
066       try {
067                          this.add(CSR.class, true, false);
068                          this.add(CSP.class, false, true);
069       } catch(HL7Exception e) {
070          log.error("Unexpected error creating PEX_P07_CSRCSP - this is probably a bug in the source code generator.", e);
071       }
072    }
073
074    /** 
075     * Returns "2.3.1"
076     */
077    public String getVersion() {
078       return "2.3.1";
079    }
080
081
082
083    /**
084     * Returns
085     * CSR (CSR - clinical study registration segment) - creates it if necessary
086     */
087    public CSR getCSR() { 
088       CSR retVal = getTyped("CSR", CSR.class);
089       return retVal;
090    }
091
092
093
094
095    /**
096     * Returns
097     * the first repetition of 
098     * CSP (CSP - clinical study phase segment) - creates it if necessary
099     */
100    public CSP getCSP() { 
101       CSP retVal = getTyped("CSP", CSP.class);
102       return retVal;
103    }
104
105
106    /**
107     * Returns a specific repetition of
108     * CSP (CSP - clinical study phase segment) - creates it if necessary
109     *
110     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
111     * @throws HL7Exception if the repetition requested is more than one 
112     *     greater than the number of existing repetitions.
113     */
114    public CSP getCSP(int rep) { 
115       CSP retVal = getTyped("CSP", rep, CSP.class);
116       return retVal;
117    }
118
119    /** 
120     * Returns the number of existing repetitions of CSP 
121     */ 
122    public int getCSPReps() {  
123        return getReps("CSP");
124    } 
125
126    /** 
127     * <p>
128     * Returns a non-modifiable List containing all current existing repetitions of CSP.
129     * <p>
130     * <p>
131     * Note that unlike {@link #getCSP()}, this method will not create any reps
132     * if none are already present, so an empty list may be returned.
133     * </p>
134     */ 
135    public List<CSP> getCSPAll() throws HL7Exception {
136        return getAllAsList("CSP", CSP.class);
137    } 
138
139    /**
140     * Inserts a specific repetition of CSP (CSP - clinical study phase segment)
141     * @see AbstractGroup#insertRepetition(Structure, int) 
142     */
143    public void insertCSP(CSP structure, int rep) throws HL7Exception { 
144       super.insertRepetition("CSP", structure, rep);
145    }
146
147
148    /**
149     * Inserts a specific repetition of CSP (CSP - clinical study phase segment)
150     * @see AbstractGroup#insertRepetition(Structure, int) 
151     */
152    public CSP insertCSP(int rep) throws HL7Exception { 
153       return (CSP)super.insertRepetition("CSP", rep);
154    }
155
156
157    /**
158     * Removes a specific repetition of CSP (CSP - clinical study phase segment)
159     * @see AbstractGroup#removeRepetition(String, int) 
160     */
161    public CSP removeCSP(int rep) throws HL7Exception { 
162       return (CSP)super.removeRepetition("CSP", rep);
163    }
164
165
166
167}
168