/*
* 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.v251.message;
import ca.uhn.hl7v2.model.v251.group.*;
import ca.uhn.hl7v2.model.v251.segment.*;
import java.util.List;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
import ca.uhn.hl7v2.model.*;
/**
* <p>Represents a ORB_O28 message structure (see chapter 4.20.2). This structure contains the
* following elements: </p>
* <ul>
* <li>1: MSH (Message Header) <b> </b> </li>
* <li>2: MSA (Message Acknowledgment) <b> </b> </li>
* <li>3: ERR (Error) <b>optional repeating</b> </li>
* <li>4: SFT (Software Segment) <b>optional repeating</b> </li>
* <li>5: NTE (Notes and Comments) <b>optional repeating</b> </li>
* <li>6: ORB_O28_RESPONSE (a Group object) <b>optional </b> </li>
* </ul>
*/
@SuppressWarnings("unused")
public class ORB_O28 extends AbstractMessage {
/**
* Creates a new ORB_O28 message with DefaultModelClassFactory.
*/
public ORB_O28() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new ORB_O28 message with custom ModelClassFactory.
*/
public ORB_O28(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(SFT.class, false, true);
this.add(NTE.class, false, true);
this.add(ORB_O28_RESPONSE.class, false, false);
} catch(HL7Exception e) {
log.error("Unexpected error creating ORB_O28 - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.5.1"
*/
public String getVersion() {
return "2.5.1";
}
/**
* <p>
* Returns
* MSH (Message Header) - creates it if necessary
* </p>
*
*
*/
public MSH getMSH() {
return getTyped("MSH", MSH.class);
}
/**
* <p>
* Returns
* MSA (Message Acknowledgment) - creates it if necessary
* </p>
*
*
*/
public MSA getMSA() {
return getTyped("MSA", MSA.class);
}
/**
* <p>
* Returns
* the first repetition of
* ERR (Error) - creates it if necessary
* </p>
*
*
*/
public ERR getERR() {
return getTyped("ERR", ERR.class);
}
/**
* <p>
* Returns a specific repetition of
* ERR (Error) - creates it if necessary
* </p>
*
*
* @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);
}
/**
* <p>
* Returns the number of existing repetitions of ERR
* </p>
*
*/
public int getERRReps() {
return getReps("ERR");
}
/**
* <p>
* Returns a non-modifiable List containing all current existing repetitions of ERR.
* <p>
* <p>
* Note that unlike {@link #getERR()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
* </p>
*
*/
public List<ERR> getERRAll() throws HL7Exception {
return getAllAsList("ERR", ERR.class);
}
/**
* <p>
* Inserts a specific repetition of ERR (Error)
* </p>
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertERR(ERR structure, int rep) throws HL7Exception {
super.insertRepetition( "ERR", structure, rep);
}
/**
* <p>
* Inserts a specific repetition of ERR (Error)
* </p>
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public ERR insertERR(int rep) throws HL7Exception {
return (ERR)super.insertRepetition("ERR", rep);
}
/**
* <p>
* Removes a specific repetition of ERR (Error)
* </p>
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public ERR removeERR(int rep) throws HL7Exception {
return (ERR)super.removeRepetition("ERR", rep);
}
/**
* <p>
* Returns
* the first repetition of
* SFT (Software Segment) - creates it if necessary
* </p>
*
*
*/
public SFT getSFT() {
return getTyped("SFT", SFT.class);
}
/**
* <p>
* Returns a specific repetition of
* SFT (Software Segment) - creates it if necessary
* </p>
*
*
* @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 SFT getSFT(int rep) {
return getTyped("SFT", rep, SFT.class);
}
/**
* <p>
* Returns the number of existing repetitions of SFT
* </p>
*
*/
public int getSFTReps() {
return getReps("SFT");
}
/**
* <p>
* Returns a non-modifiable List containing all current existing repetitions of SFT.
* <p>
* <p>
* Note that unlike {@link #getSFT()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
* </p>
*
*/
public List<SFT> getSFTAll() throws HL7Exception {
return getAllAsList("SFT", SFT.class);
}
/**
* <p>
* Inserts a specific repetition of SFT (Software Segment)
* </p>
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertSFT(SFT structure, int rep) throws HL7Exception {
super.insertRepetition( "SFT", structure, rep);
}
/**
* <p>
* Inserts a specific repetition of SFT (Software Segment)
* </p>
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public SFT insertSFT(int rep) throws HL7Exception {
return (SFT)super.insertRepetition("SFT", rep);
}
/**
* <p>
* Removes a specific repetition of SFT (Software Segment)
* </p>
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public SFT removeSFT(int rep) throws HL7Exception {
return (SFT)super.removeRepetition("SFT", rep);
}
/**
* <p>
* Returns
* the first repetition of
* NTE (Notes and Comments) - creates it if necessary
* </p>
*
*
*/
public NTE getNTE() {
return getTyped("NTE", NTE.class);
}
/**
* <p>
* Returns a specific repetition of
* NTE (Notes and Comments) - creates it if necessary
* </p>
*
*
* @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) {
return getTyped("NTE", rep, NTE.class);
}
/**
* <p>
* Returns the number of existing repetitions of NTE
* </p>
*
*/
public int getNTEReps() {
return getReps("NTE");
}
/**
* <p>
* Returns a non-modifiable List containing all current existing repetitions of NTE.
* <p>
* <p>
* Note that unlike {@link #getNTE()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
* </p>
*
*/
public List<NTE> getNTEAll() throws HL7Exception {
return getAllAsList("NTE", NTE.class);
}
/**
* <p>
* Inserts a specific repetition of NTE (Notes and Comments)
* </p>
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertNTE(NTE structure, int rep) throws HL7Exception {
super.insertRepetition( "NTE", structure, rep);
}
/**
* <p>
* Inserts a specific repetition of NTE (Notes and Comments)
* </p>
*
*
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public NTE insertNTE(int rep) throws HL7Exception {
return (NTE)super.insertRepetition("NTE", rep);
}
/**
* <p>
* Removes a specific repetition of NTE (Notes and Comments)
* </p>
*
*
* @see AbstractGroup#removeRepetition(String, int)
*/
public NTE removeNTE(int rep) throws HL7Exception {
return (NTE)super.removeRepetition("NTE", rep);
}
/**
* <p>
* Returns
* RESPONSE (a Group object) - creates it if necessary
* </p>
*
*
*/
public ORB_O28_RESPONSE getRESPONSE() {
return getTyped("RESPONSE", ORB_O28_RESPONSE.class);
}
}