All Downloads are FREE. Search and download functionalities are using the official Maven repository.

ca.uhn.hl7v2.model.v231.group.PPG_PCG_GOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR Maven / Gradle / Ivy

There is a newer version: 2.5.1
Show newest version
/*
 * This class is an auto-generated source file for a HAPI
 * HL7 v2.x standard structure class.
 *
 * For more information, visit: http://hl7api.sourceforge.net/
 * 
 * The contents of this file are subject to the Mozilla Public License Version 1.1 
 * (the "License"); you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
 * Software distributed under the License is distributed on an "AS IS" basis, 
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
 * specific language governing rights and limitations under the License. 
 * 
 * The Original Code is "[file_name]".  Description: 
 * "[one_line_description]" 
 * 
 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
 * 2012.  All Rights Reserved. 
 * 
 * Contributor(s): ______________________________________. 
 * 
 * Alternatively, the contents of this file may be used under the terms of the 
 * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
 * applicable instead of those above.  If you wish to allow use of your version of this 
 * file only under the terms of the GPL and not to allow others to use your version 
 * of this file under the MPL, indicate your decision by deleting  the provisions above 
 * and replace  them with the notice and other provisions required by the GPL License.  
 * If you do not delete the provisions above, a recipient may use your version of 
 * this file under either the MPL or the GPL. 
 * 
 */


package ca.uhn.hl7v2.model.v231.group;

import ca.uhn.hl7v2.model.v231.segment.*;

import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.model.*;

/**
 * 

Represents a PPG_PCG_GOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR 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: GOL (Goal Detail)
  • *
  • 2: NTE (NTE - notes and comments segment) optional repeating
  • *
  • 3: VAR (Variance) optional repeating
  • *
  • 4: PPG_PCG_ROLVAR (a Group object) optional repeating
  • *
  • 5: PPG_PCG_OBXNTE (a Group object) optional repeating
  • *
  • 6: PPG_PCG_PRBNTEVARROLVAROBXNTE (a Group object) optional repeating
  • *
  • 7: PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR (a Group object) optional repeating
  • *
*/ //@SuppressWarnings("unused") public class PPG_PCG_GOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR extends AbstractGroup { /** * Creates a new PPG_PCG_GOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR group */ public PPG_PCG_GOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(Group parent, ModelClassFactory factory) { super(parent, factory); init(factory); } private void init(ModelClassFactory factory) { try { this.add(GOL.class, true, false, false); this.add(NTE.class, false, true, false); this.add(VAR.class, false, true, false); this.add(PPG_PCG_ROLVAR.class, false, true, false); this.add(PPG_PCG_OBXNTE.class, false, true, false); this.add(PPG_PCG_PRBNTEVARROLVAROBXNTE.class, false, true, false); this.add(PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR.class, false, true, false); } catch(HL7Exception e) { log.error("Unexpected error creating PPG_PCG_GOLNTEVARROLVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR - this is probably a bug in the source code generator.", e); } } /** * Returns "2.3.1" */ public String getVersion() { return "2.3.1"; } /** * Returns * GOL (Goal Detail) - creates it if necessary */ public GOL getGOL() { GOL retVal = getTyped("GOL", GOL.class); return retVal; } /** * Returns * the first repetition of * NTE (NTE - notes and comments segment) - creates it if necessary */ public NTE getNTE() { NTE retVal = getTyped("NTE", NTE.class); return retVal; } /** * Returns a specific repetition of * NTE (NTE - notes and comments segment) - creates it if necessary * * @param 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. */ public NTE getNTE(int rep) { NTE retVal = getTyped("NTE", rep, NTE.class); return retVal; } /** * Returns the number of existing repetitions of NTE */ public int getNTEReps() { return getReps("NTE"); } /** *

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

*

* Note that unlike {@link #getNTE()}, this method will not create any reps * if none are already present, so an empty list may be returned. *

*/ public java.util.List getNTEAll() throws HL7Exception { return getAllAsList("NTE", NTE.class); } /** * Inserts a specific repetition of NTE (NTE - notes and comments segment) * @see AbstractGroup#insertRepetition(Structure, int) */ public void insertNTE(NTE structure, int rep) throws HL7Exception { super.insertRepetition("NTE", structure, rep); } /** * Inserts a specific repetition of NTE (NTE - notes and comments segment) * @see AbstractGroup#insertRepetition(Structure, int) */ public NTE insertNTE(int rep) throws HL7Exception { return (NTE)super.insertRepetition("NTE", rep); } /** * Removes a specific repetition of NTE (NTE - notes and comments segment) * @see AbstractGroup#removeRepetition(String, int) */ public NTE removeNTE(int rep) throws HL7Exception { return (NTE)super.removeRepetition("NTE", rep); } /** * Returns * the first repetition of * VAR (Variance) - creates it if necessary */ public VAR getVAR() { VAR retVal = getTyped("VAR", VAR.class); return retVal; } /** * Returns a specific repetition of * VAR (Variance) - creates it if necessary * * @param 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. */ public VAR getVAR(int rep) { VAR retVal = getTyped("VAR", rep, VAR.class); return retVal; } /** * Returns the number of existing repetitions of VAR */ public int getVARReps() { return getReps("VAR"); } /** *

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

*

* Note that unlike {@link #getVAR()}, this method will not create any reps * if none are already present, so an empty list may be returned. *

*/ public java.util.List getVARAll() throws HL7Exception { return getAllAsList("VAR", VAR.class); } /** * Inserts a specific repetition of VAR (Variance) * @see AbstractGroup#insertRepetition(Structure, int) */ public void insertVAR(VAR structure, int rep) throws HL7Exception { super.insertRepetition("VAR", structure, rep); } /** * Inserts a specific repetition of VAR (Variance) * @see AbstractGroup#insertRepetition(Structure, int) */ public VAR insertVAR(int rep) throws HL7Exception { return (VAR)super.insertRepetition("VAR", rep); } /** * Removes a specific repetition of VAR (Variance) * @see AbstractGroup#removeRepetition(String, int) */ public VAR removeVAR(int rep) throws HL7Exception { return (VAR)super.removeRepetition("VAR", rep); } /** * Returns * the first repetition of * ROLVAR (a Group object) - creates it if necessary */ public PPG_PCG_ROLVAR getROLVAR() { PPG_PCG_ROLVAR retVal = getTyped("ROLVAR", PPG_PCG_ROLVAR.class); return retVal; } /** * Returns a specific repetition of * ROLVAR (a Group object) - creates it if necessary * * @param 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. */ public PPG_PCG_ROLVAR getROLVAR(int rep) { PPG_PCG_ROLVAR retVal = getTyped("ROLVAR", rep, PPG_PCG_ROLVAR.class); return retVal; } /** * Returns the number of existing repetitions of ROLVAR */ public int getROLVARReps() { return getReps("ROLVAR"); } /** *

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

*

* Note that unlike {@link #getROLVAR()}, this method will not create any reps * if none are already present, so an empty list may be returned. *

*/ public java.util.List getROLVARAll() throws HL7Exception { return getAllAsList("ROLVAR", PPG_PCG_ROLVAR.class); } /** * Inserts a specific repetition of ROLVAR (a Group object) * @see AbstractGroup#insertRepetition(Structure, int) */ public void insertROLVAR(PPG_PCG_ROLVAR structure, int rep) throws HL7Exception { super.insertRepetition("ROLVAR", structure, rep); } /** * Inserts a specific repetition of ROLVAR (a Group object) * @see AbstractGroup#insertRepetition(Structure, int) */ public PPG_PCG_ROLVAR insertROLVAR(int rep) throws HL7Exception { return (PPG_PCG_ROLVAR)super.insertRepetition("ROLVAR", rep); } /** * Removes a specific repetition of ROLVAR (a Group object) * @see AbstractGroup#removeRepetition(String, int) */ public PPG_PCG_ROLVAR removeROLVAR(int rep) throws HL7Exception { return (PPG_PCG_ROLVAR)super.removeRepetition("ROLVAR", rep); } /** * Returns * the first repetition of * OBXNTE (a Group object) - creates it if necessary */ public PPG_PCG_OBXNTE getOBXNTE() { PPG_PCG_OBXNTE retVal = getTyped("OBXNTE", PPG_PCG_OBXNTE.class); return retVal; } /** * Returns a specific repetition of * OBXNTE (a Group object) - creates it if necessary * * @param 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. */ public PPG_PCG_OBXNTE getOBXNTE(int rep) { PPG_PCG_OBXNTE retVal = getTyped("OBXNTE", rep, PPG_PCG_OBXNTE.class); return retVal; } /** * Returns the number of existing repetitions of OBXNTE */ public int getOBXNTEReps() { return getReps("OBXNTE"); } /** *

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

*

* Note that unlike {@link #getOBXNTE()}, this method will not create any reps * if none are already present, so an empty list may be returned. *

*/ public java.util.List getOBXNTEAll() throws HL7Exception { return getAllAsList("OBXNTE", PPG_PCG_OBXNTE.class); } /** * Inserts a specific repetition of OBXNTE (a Group object) * @see AbstractGroup#insertRepetition(Structure, int) */ public void insertOBXNTE(PPG_PCG_OBXNTE structure, int rep) throws HL7Exception { super.insertRepetition("OBXNTE", structure, rep); } /** * Inserts a specific repetition of OBXNTE (a Group object) * @see AbstractGroup#insertRepetition(Structure, int) */ public PPG_PCG_OBXNTE insertOBXNTE(int rep) throws HL7Exception { return (PPG_PCG_OBXNTE)super.insertRepetition("OBXNTE", rep); } /** * Removes a specific repetition of OBXNTE (a Group object) * @see AbstractGroup#removeRepetition(String, int) */ public PPG_PCG_OBXNTE removeOBXNTE(int rep) throws HL7Exception { return (PPG_PCG_OBXNTE)super.removeRepetition("OBXNTE", rep); } /** * Returns * the first repetition of * PRBNTEVARROLVAROBXNTE (a Group object) - creates it if necessary */ public PPG_PCG_PRBNTEVARROLVAROBXNTE getPRBNTEVARROLVAROBXNTE() { PPG_PCG_PRBNTEVARROLVAROBXNTE retVal = getTyped("PRBNTEVARROLVAROBXNTE", PPG_PCG_PRBNTEVARROLVAROBXNTE.class); return retVal; } /** * Returns a specific repetition of * PRBNTEVARROLVAROBXNTE (a Group object) - creates it if necessary * * @param 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. */ public PPG_PCG_PRBNTEVARROLVAROBXNTE getPRBNTEVARROLVAROBXNTE(int rep) { PPG_PCG_PRBNTEVARROLVAROBXNTE retVal = getTyped("PRBNTEVARROLVAROBXNTE", rep, PPG_PCG_PRBNTEVARROLVAROBXNTE.class); return retVal; } /** * Returns the number of existing repetitions of PRBNTEVARROLVAROBXNTE */ public int getPRBNTEVARROLVAROBXNTEReps() { return getReps("PRBNTEVARROLVAROBXNTE"); } /** *

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

*

* Note that unlike {@link #getPRBNTEVARROLVAROBXNTE()}, this method will not create any reps * if none are already present, so an empty list may be returned. *

*/ public java.util.List getPRBNTEVARROLVAROBXNTEAll() throws HL7Exception { return getAllAsList("PRBNTEVARROLVAROBXNTE", PPG_PCG_PRBNTEVARROLVAROBXNTE.class); } /** * Inserts a specific repetition of PRBNTEVARROLVAROBXNTE (a Group object) * @see AbstractGroup#insertRepetition(Structure, int) */ public void insertPRBNTEVARROLVAROBXNTE(PPG_PCG_PRBNTEVARROLVAROBXNTE structure, int rep) throws HL7Exception { super.insertRepetition("PRBNTEVARROLVAROBXNTE", structure, rep); } /** * Inserts a specific repetition of PRBNTEVARROLVAROBXNTE (a Group object) * @see AbstractGroup#insertRepetition(Structure, int) */ public PPG_PCG_PRBNTEVARROLVAROBXNTE insertPRBNTEVARROLVAROBXNTE(int rep) throws HL7Exception { return (PPG_PCG_PRBNTEVARROLVAROBXNTE)super.insertRepetition("PRBNTEVARROLVAROBXNTE", rep); } /** * Removes a specific repetition of PRBNTEVARROLVAROBXNTE (a Group object) * @see AbstractGroup#removeRepetition(String, int) */ public PPG_PCG_PRBNTEVARROLVAROBXNTE removePRBNTEVARROLVAROBXNTE(int rep) throws HL7Exception { return (PPG_PCG_PRBNTEVARROLVAROBXNTE)super.removeRepetition("PRBNTEVARROLVAROBXNTE", rep); } /** * Returns * the first repetition of * ORCOBRRXONTEVAROBXNTEVAR (a Group object) - creates it if necessary */ public PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR getORCOBRRXONTEVAROBXNTEVAR() { PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR retVal = getTyped("ORCOBRRXONTEVAROBXNTEVAR", PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR.class); return retVal; } /** * Returns a specific repetition of * ORCOBRRXONTEVAROBXNTEVAR (a Group object) - creates it if necessary * * @param 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. */ public PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR getORCOBRRXONTEVAROBXNTEVAR(int rep) { PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR retVal = getTyped("ORCOBRRXONTEVAROBXNTEVAR", rep, PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR.class); return retVal; } /** * Returns the number of existing repetitions of ORCOBRRXONTEVAROBXNTEVAR */ public int getORCOBRRXONTEVAROBXNTEVARReps() { return getReps("ORCOBRRXONTEVAROBXNTEVAR"); } /** *

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

*

* Note that unlike {@link #getORCOBRRXONTEVAROBXNTEVAR()}, this method will not create any reps * if none are already present, so an empty list may be returned. *

*/ public java.util.List getORCOBRRXONTEVAROBXNTEVARAll() throws HL7Exception { return getAllAsList("ORCOBRRXONTEVAROBXNTEVAR", PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR.class); } /** * Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object) * @see AbstractGroup#insertRepetition(Structure, int) */ public void insertORCOBRRXONTEVAROBXNTEVAR(PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR structure, int rep) throws HL7Exception { super.insertRepetition("ORCOBRRXONTEVAROBXNTEVAR", structure, rep); } /** * Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object) * @see AbstractGroup#insertRepetition(Structure, int) */ public PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR insertORCOBRRXONTEVAROBXNTEVAR(int rep) throws HL7Exception { return (PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR)super.insertRepetition("ORCOBRRXONTEVAROBXNTEVAR", rep); } /** * Removes a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object) * @see AbstractGroup#removeRepetition(String, int) */ public PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR removeORCOBRRXONTEVAROBXNTEVAR(int rep) throws HL7Exception { return (PPG_PCG_ORCOBRRXONTEVAROBXNTEVAR)super.removeRepetition("ORCOBRRXONTEVAROBXNTEVAR", rep); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy