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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hapi-structures-v231 Show documentation
There is a newer version: 2.5.1
/*
 * 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 MFN_M05_LDPLCHLCC 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: LDP (LDP - location department segment)   
                         * 2: LCH (LCH - location characteristic segment) optional repeating 
                         * 3: LCC (LCC - location charge code segment) optional repeating 
 * 
 */
//@SuppressWarnings("unused")
public class MFN_M05_LDPLCHLCC extends AbstractGroup {

    /** 
     * Creates a new MFN_M05_LDPLCHLCC group
     */
    public MFN_M05_LDPLCHLCC(Group parent, ModelClassFactory factory) {
       super(parent, factory);
       init(factory);
    }

    private void init(ModelClassFactory factory) {
       try {
                                  this.add(LDP.class, true, false, false);
                                  this.add(LCH.class, false, true, false);
                                  this.add(LCC.class, false, true, false);
       } catch(HL7Exception e) {
          log.error("Unexpected error creating MFN_M05_LDPLCHLCC - this is probably a bug in the source code generator.", e);
       }
    }

    /** 
     * Returns "2.3.1"
     */
    public String getVersion() {
       return "2.3.1";
    }



    /**
     * Returns
     * LDP (LDP - location department segment) - creates it if necessary
     */
    public LDP getLDP() { 
       LDP retVal = getTyped("LDP", LDP.class);
       return retVal;
    }




    /**
     * Returns
     * the first repetition of 
     * LCH (LCH - location characteristic segment) - creates it if necessary
     */
    public LCH getLCH() { 
       LCH retVal = getTyped("LCH", LCH.class);
       return retVal;
    }


    /**
     * Returns a specific repetition of
     * LCH (LCH - location characteristic 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 LCH getLCH(int rep) { 
       LCH retVal = getTyped("LCH", rep, LCH.class);
       return retVal;
    }

    /** 
     * Returns the number of existing repetitions of LCH 
     */ 
    public int getLCHReps() {  
        return getReps("LCH");
    } 

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

     * 

     * Note that unlike {@link #getLCH()}, this method will not create any reps
     * if none are already present, so an empty list may be returned.
     * 
     */ 
    public java.util.List getLCHAll() throws HL7Exception {
    	return getAllAsList("LCH", LCH.class);
    } 

    /**
     * Inserts a specific repetition of LCH (LCH - location characteristic segment)
     * @see AbstractGroup#insertRepetition(Structure, int) 
     */
    public void insertLCH(LCH structure, int rep) throws HL7Exception { 
       super.insertRepetition("LCH", structure, rep);
    }


    /**
     * Inserts a specific repetition of LCH (LCH - location characteristic segment)
     * @see AbstractGroup#insertRepetition(Structure, int) 
     */
    public LCH insertLCH(int rep) throws HL7Exception { 
       return (LCH)super.insertRepetition("LCH", rep);
    }


    /**
     * Removes a specific repetition of LCH (LCH - location characteristic segment)
     * @see AbstractGroup#removeRepetition(String, int) 
     */
    public LCH removeLCH(int rep) throws HL7Exception { 
       return (LCH)super.removeRepetition("LCH", rep);
    }



    /**
     * Returns
     * the first repetition of 
     * LCC (LCC - location charge code segment) - creates it if necessary
     */
    public LCC getLCC() { 
       LCC retVal = getTyped("LCC", LCC.class);
       return retVal;
    }


    /**
     * Returns a specific repetition of
     * LCC (LCC - location charge code 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 LCC getLCC(int rep) { 
       LCC retVal = getTyped("LCC", rep, LCC.class);
       return retVal;
    }

    /** 
     * Returns the number of existing repetitions of LCC 
     */ 
    public int getLCCReps() {  
        return getReps("LCC");
    } 

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

     * 

     * Note that unlike {@link #getLCC()}, this method will not create any reps
     * if none are already present, so an empty list may be returned.
     * 
     */ 
    public java.util.List getLCCAll() throws HL7Exception {
    	return getAllAsList("LCC", LCC.class);
    } 

    /**
     * Inserts a specific repetition of LCC (LCC - location charge code segment)
     * @see AbstractGroup#insertRepetition(Structure, int) 
     */
    public void insertLCC(LCC structure, int rep) throws HL7Exception { 
       super.insertRepetition("LCC", structure, rep);
    }


    /**
     * Inserts a specific repetition of LCC (LCC - location charge code segment)
     * @see AbstractGroup#insertRepetition(Structure, int) 
     */
    public LCC insertLCC(int rep) throws HL7Exception { 
       return (LCC)super.insertRepetition("LCC", rep);
    }


    /**
     * Removes a specific repetition of LCC (LCC - location charge code segment)
     * @see AbstractGroup#removeRepetition(String, int) 
     */
    public LCC removeLCC(int rep) throws HL7Exception { 
       return (LCC)super.removeRepetition("LCC", rep);
    }



}