View Javadoc
1   /*
2    * This class is an auto-generated source file for a HAPI
3    * HL7 v2.x standard structure class.
4    *
5    * For more information, visit: http://hl7api.sourceforge.net/
6    * 
7    * The contents of this file are subject to the Mozilla Public License Version 1.1 
8    * (the "License"); you may not use this file except in compliance with the License. 
9    * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
10   * Software distributed under the License is distributed on an "AS IS" basis, 
11   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
12   * specific language governing rights and limitations under the License. 
13   * 
14   * The Original Code is "[file_name]".  Description: 
15   * "[one_line_description]" 
16   * 
17   * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
18   * 2012.  All Rights Reserved. 
19   * 
20   * Contributor(s): ______________________________________. 
21   * 
22   * Alternatively, the contents of this file may be used under the terms of the 
23   * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
24   * applicable instead of those above.  If you wish to allow use of your version of this 
25   * file only under the terms of the GPL and not to allow others to use your version 
26   * of this file under the MPL, indicate your decision by deleting  the provisions above 
27   * and replace  them with the notice and other provisions required by the GPL License.  
28   * If you do not delete the provisions above, a recipient may use your version of 
29   * this file under either the MPL or the GPL. 
30   * 
31   */
32  
33  
34  package ca.uhn.hl7v2.model.v26.group;
35  
36  import ca.uhn.hl7v2.model.v26.segment.*;
37  
38  import ca.uhn.hl7v2.HL7Exception;
39  import ca.uhn.hl7v2.parser.ModelClassFactory;
40  import ca.uhn.hl7v2.model.*;
41  
42  /**
43   * <p>Represents a EHC_E04_PRODUCT_SERVICE_GROUP group structure (a Group object).
44   * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
45   * This Group contains the following elements:  
46   * </p>
47   * <ul>
48                           * <li>1: PSG (Product/Service Group) <b>  choice</b></li>
49                           * <li>2: PSL (Product/Service Line Item) <b>optional repeating choice</b></li>
50   * </ul>
51   * <p>
52   * Note that this structure has "choice" elements. This means that one of the 
53   * structures above marked as "choice" must be present, but no more than one.
54   * </p> 
55   */
56  //@SuppressWarnings("unused")
57  public class EHC_E04_PRODUCT_SERVICE_GROUP extends AbstractGroup {
58  
59      /** 
60       * Creates a new EHC_E04_PRODUCT_SERVICE_GROUP group
61       */
62      public EHC_E04_PRODUCT_SERVICE_GROUP(Group parent, ModelClassFactory factory) {
63         super(parent, factory);
64         init(factory);
65      }
66  
67      private void init(ModelClassFactory factory) {
68         try {
69                                    this.add(PSG.class, true, false, true);
70                                    this.add(PSL.class, false, true, true);
71         } catch(HL7Exception e) {
72            log.error("Unexpected error creating EHC_E04_PRODUCT_SERVICE_GROUP - this is probably a bug in the source code generator.", e);
73         }
74      }
75  
76      /** 
77       * Returns "2.6"
78       */
79      public String getVersion() {
80         return "2.6";
81      }
82  
83  
84  
85      /**
86       * Returns
87       * PSG (Product/Service Group) - creates it if necessary
88       */
89      public PSG getPSG() { 
90         PSG retVal = getTyped("PSG", PSG.class);
91         return retVal;
92      }
93  
94  
95  
96  
97      /**
98       * Returns
99       * the first repetition of 
100      * PSL (Product/Service Line Item) - creates it if necessary
101      */
102     public PSL getPSL() { 
103        PSL retVal = getTyped("PSL", PSL.class);
104        return retVal;
105     }
106 
107 
108     /**
109      * Returns a specific repetition of
110      * PSL (Product/Service Line Item) - creates it if necessary
111      *
112      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
113      * @throws HL7Exception if the repetition requested is more than one 
114      *     greater than the number of existing repetitions.
115      */
116     public PSL getPSL(int rep) { 
117        PSL retVal = getTyped("PSL", rep, PSL.class);
118        return retVal;
119     }
120 
121     /** 
122      * Returns the number of existing repetitions of PSL 
123      */ 
124     public int getPSLReps() {  
125         return getReps("PSL");
126     } 
127 
128     /** 
129      * <p>
130      * Returns a non-modifiable List containing all current existing repetitions of PSL.
131      * <p>
132      * <p>
133      * Note that unlike {@link #getPSL()}, this method will not create any reps
134      * if none are already present, so an empty list may be returned.
135      * </p>
136      */ 
137     public java.util.List<PSL> getPSLAll() throws HL7Exception {
138     	return getAllAsList("PSL", PSL.class);
139     } 
140 
141     /**
142      * Inserts a specific repetition of PSL (Product/Service Line Item)
143      * @see AbstractGroup#insertRepetition(Structure, int) 
144      */
145     public void insertPSL(PSL structure, int rep) throws HL7Exception { 
146        super.insertRepetition("PSL", structure, rep);
147     }
148 
149 
150     /**
151      * Inserts a specific repetition of PSL (Product/Service Line Item)
152      * @see AbstractGroup#insertRepetition(Structure, int) 
153      */
154     public PSL insertPSL(int rep) throws HL7Exception { 
155        return (PSL)super.insertRepetition("PSL", rep);
156     }
157 
158 
159     /**
160      * Removes a specific repetition of PSL (Product/Service Line Item)
161      * @see AbstractGroup#removeRepetition(String, int) 
162      */
163     public PSL removePSL(int rep) throws HL7Exception { 
164        return (PSL)super.removeRepetition("PSL", rep);
165     }
166 
167 
168 
169 }
170