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.v24.segment;
035
036// import ca.uhn.hl7v2.model.v24.group.*;
037import ca.uhn.hl7v2.model.v24.datatype.*;
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
041import ca.uhn.hl7v2.model.AbstractMessage;
042import ca.uhn.hl7v2.model.Group;
043import ca.uhn.hl7v2.model.Type;
044import ca.uhn.hl7v2.model.AbstractSegment;
045import ca.uhn.hl7v2.model.Varies;
046
047
048/**
049 *<p>Represents an HL7 QPD message segment (Query Parameter Definition). 
050 * This segment has the following fields:</p>
051 * <ul>
052     * <li>QPD-1: Message Query Name (CE) <b> </b>
053     * <li>QPD-2: Query Tag (ST) <b>optional </b>
054     * <li>QPD-3: User Parameters (in successive fields) (Varies) <b>optional </b>
055 * </ul>
056 */
057@SuppressWarnings("unused")
058public class QPD extends AbstractSegment {
059
060    /** 
061     * Creates a new QPD segment
062     */
063    public QPD(Group parent, ModelClassFactory factory) {
064       super(parent, factory);
065       init(factory);
066    }
067
068    private void init(ModelClassFactory factory) {
069       try {
070                                  this.add(CE.class, true, 1, 250, new Object[]{ getMessage() }, "Message Query Name");
071                                  this.add(ST.class, false, 1, 32, new Object[]{ getMessage() }, "Query Tag");
072                                  this.add(Varies.class, false, 1, 256, new Object[]{ getMessage() }, "User Parameters (in successive fields)");
073       } catch(HL7Exception e) {
074          log.error("Unexpected error creating QPD - this is probably a bug in the source code generator.", e);
075       }
076    }
077
078
079
080    /**
081     * Returns
082     * QPD-1: "Message Query Name" - creates it if necessary
083     */
084    public CE getMessageQueryName() { 
085                CE retVal = this.getTypedField(1, 0);
086                return retVal;
087    }
088    
089    /**
090     * Returns
091     * QPD-1: "Message Query Name" - creates it if necessary
092     */
093    public CE getQpd1_MessageQueryName() { 
094                CE retVal = this.getTypedField(1, 0);
095                return retVal;
096    }
097
098
099
100    /**
101     * Returns
102     * QPD-2: "Query Tag" - creates it if necessary
103     */
104    public ST getQueryTag() { 
105                ST retVal = this.getTypedField(2, 0);
106                return retVal;
107    }
108    
109    /**
110     * Returns
111     * QPD-2: "Query Tag" - creates it if necessary
112     */
113    public ST getQpd2_QueryTag() { 
114                ST retVal = this.getTypedField(2, 0);
115                return retVal;
116    }
117
118
119
120    /**
121     * Returns
122     * QPD-3: "User Parameters (in successive fields)" - creates it if necessary
123     */
124    public Varies getUserParametersInsuccessivefields() { 
125                Varies retVal = this.getTypedField(3, 0);
126                return retVal;
127    }
128    
129    /**
130     * Returns
131     * QPD-3: "User Parameters (in successive fields)" - creates it if necessary
132     */
133    public Varies getQpd3_UserParametersInsuccessivefields() { 
134                Varies retVal = this.getTypedField(3, 0);
135                return retVal;
136    }
137
138
139
140
141
142    /** {@inheritDoc} */   
143    protected Type createNewTypeWithoutReflection(int field) {
144       switch (field) {
145          case 0: return new CE(getMessage());
146          case 1: return new ST(getMessage());
147          case 2: return new Varies(getMessage());
148          default: return null;
149       }
150   }
151
152
153}
154