ca.uhn.hl7v2.model.v26.message.SRR_S01 Maven / Gradle / Ivy

/*
 * 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.v26.message;

import ca.uhn.hl7v2.model.v26.group.*;
import ca.uhn.hl7v2.model.v26.segment.*;

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


/**
 * Represents a SRR_S01 message structure (see chapter 10.3). This structure contains the 
 * following elements: 
 * 
		                 * 1: MSH (Message Header)   
		                 * 2: MSA (Message Acknowledgment)   
		                 * 3: ERR (Error) optional repeating 
		                 * 4: SRR_S01_SCHEDULE (a Group object) optional  
 * 
 */
//@SuppressWarnings("unused")
public class SRR_S01 extends AbstractMessage  {

    /**
     * Creates a new SRR_S01 message with DefaultModelClassFactory. 
     */ 
    public SRR_S01() { 
       this(new DefaultModelClassFactory());
    }

    /** 
     * Creates a new SRR_S01 message with custom ModelClassFactory.
     */
    public SRR_S01(ModelClassFactory factory) {
       super(factory);
       init(factory);
    }

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


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




    /**
     * 
     * Returns
     * MSH (Message Header) - creates it if necessary
     * 
     * 
     *
     */
    public MSH getMSH() { 
       return getTyped("MSH", MSH.class);
    }





    /**
     * 
     * Returns
     * MSA (Message Acknowledgment) - creates it if necessary
     * 
     * 
     *
     */
    public MSA getMSA() { 
       return getTyped("MSA", MSA.class);
    }





    /**
     * 
     * Returns
     * the first repetition of 
     * ERR (Error) - creates it if necessary
     * 
     * 
     *
     */
    public ERR getERR() { 
       return getTyped("ERR", ERR.class);
    }


    /**
     * 
     * Returns a specific repetition of
     * ERR (Error) - 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 ERR getERR(int rep) { 
       return getTyped("ERR", rep, ERR.class);
    }

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

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

     * 

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

    /**
     * 
     * Inserts a specific repetition of ERR (Error)
     * 
     * 
     *
     * @see AbstractGroup#insertRepetition(Structure, int) 
     */
    public void insertERR(ERR structure, int rep) throws HL7Exception { 
       super.insertRepetition( "ERR", structure, rep);
    }


    /**
     * 
     * Inserts a specific repetition of ERR (Error)
     * 
     * 
     *
     * @see AbstractGroup#insertRepetition(Structure, int) 
     */
    public ERR insertERR(int rep) throws HL7Exception { 
       return (ERR)super.insertRepetition("ERR", rep);
    }


    /**
     * 
     * Removes a specific repetition of ERR (Error)
     * 
     * 
     *
     * @see AbstractGroup#removeRepetition(String, int) 
     */
    public ERR removeERR(int rep) throws HL7Exception { 
       return (ERR)super.removeRepetition("ERR", rep);
    }




    /**
     * 
     * Returns
     * SCHEDULE (a Group object) - creates it if necessary
     * 
     * 
     *
     */
    public SRR_S01_SCHEDULE getSCHEDULE() { 
       return getTyped("SCHEDULE", SRR_S01_SCHEDULE.class);
    }




}