ca.uhn.hl7v2.model.v26.message.ORF_R04 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 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.AbstractMessage;
/**
* Represents a ORF_R04 message structure (see chapter 7.3.3). This structure contains the
* following elements:
*
* - 1: MSH (Message Header)
* - 2: SFT (Software Segment) optional repeating
* - 3: UAC (User Authentication Credential Segment) optional
* - 4: MSA (Message Acknowledgment)
* - 5: QRD (Original-Style Query Definition)
* - 6: QRF (Original style query filter) optional
* - 7: ORF_R04_QUERY_RESPONSE (a Group object) repeating
* - 8: ERR (Error) optional repeating
* - 9: QAK (Query Acknowledgment) optional
* - 10: DSC (Continuation Pointer) optional
*
*/
public class ORF_R04 extends AbstractMessage {
/**
* Creates a new ORF_R04 message with DefaultModelClassFactory.
*/
public ORF_R04() {
this(new DefaultModelClassFactory());
}
/**
* Creates a new ORF_R04 message with custom ModelClassFactory.
*/
public ORF_R04(ModelClassFactory factory) {
super(factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(MSH.class, true, false);
this.add(SFT.class, false, true);
this.add(UAC.class, false, false);
this.add(MSA.class, true, false);
this.add(QRD.class, true, false);
this.add(QRF.class, false, false);
this.add(ORF_R04_QUERY_RESPONSE.class, true, true);
this.add(ERR.class, false, true);
this.add(QAK.class, false, false);
this.add(DSC.class, false, false);
} catch(HL7Exception e) {
log.error("Unexpected error creating ORF_R04 - 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
* the first repetition of
* SFT (Software Segment) - creates it if necessary
*/
public SFT getSFT() {
return getTyped("SFT", SFT.class);
}
/**
* Returns a specific repetition of
* SFT (Software 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 SFT getSFT(int rep) {
return getTyped("SFT", rep, SFT.class);
}
/**
* Returns the number of existing repetitions of SFT
*/
public int getSFTReps() {
return getReps("SFT");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of SFT.
*
*
* Note that unlike {@link #getSFT()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getSFTAll() throws HL7Exception {
return getAllAsList("SFT", SFT.class);
}
/**
* Inserts a specific repetition of SFT (Software Segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertSFT(SFT structure, int rep) throws HL7Exception {
super.insertRepetition( "SFT", structure, rep);
}
/**
* Inserts a specific repetition of SFT (Software Segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public SFT insertSFT(int rep) throws HL7Exception {
return (SFT)super.insertRepetition("SFT", rep);
}
/**
* Removes a specific repetition of SFT (Software Segment)
* @see AbstractGroup#removeRepetition(String, int)
*/
public SFT removeSFT(int rep) throws HL7Exception {
return (SFT)super.removeRepetition("SFT", rep);
}
/**
* Returns
* UAC (User Authentication Credential Segment) - creates it if necessary
*/
public UAC getUAC() {
return getTyped("UAC", UAC.class);
}
/**
* Returns
* MSA (Message Acknowledgment) - creates it if necessary
*/
public MSA getMSA() {
return getTyped("MSA", MSA.class);
}
/**
* Returns
* QRD (Original-Style Query Definition) - creates it if necessary
*/
public QRD getQRD() {
return getTyped("QRD", QRD.class);
}
/**
* Returns
* QRF (Original style query filter) - creates it if necessary
*/
public QRF getQRF() {
return getTyped("QRF", QRF.class);
}
/**
* Returns
* the first repetition of
* QUERY_RESPONSE (a Group object) - creates it if necessary
*/
public ORF_R04_QUERY_RESPONSE getQUERY_RESPONSE() {
return getTyped("QUERY_RESPONSE", ORF_R04_QUERY_RESPONSE.class);
}
/**
* Returns a specific repetition of
* QUERY_RESPONSE (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 ORF_R04_QUERY_RESPONSE getQUERY_RESPONSE(int rep) {
return getTyped("QUERY_RESPONSE", rep, ORF_R04_QUERY_RESPONSE.class);
}
/**
* Returns the number of existing repetitions of QUERY_RESPONSE
*/
public int getQUERY_RESPONSEReps() {
return getReps("QUERY_RESPONSE");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of QUERY_RESPONSE.
*
*
* Note that unlike {@link #getQUERY_RESPONSE()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public List getQUERY_RESPONSEAll() throws HL7Exception {
return getAllAsList("QUERY_RESPONSE", ORF_R04_QUERY_RESPONSE.class);
}
/**
* Inserts a specific repetition of QUERY_RESPONSE (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertQUERY_RESPONSE(ORF_R04_QUERY_RESPONSE structure, int rep) throws HL7Exception {
super.insertRepetition( "QUERY_RESPONSE", structure, rep);
}
/**
* Inserts a specific repetition of QUERY_RESPONSE (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public ORF_R04_QUERY_RESPONSE insertQUERY_RESPONSE(int rep) throws HL7Exception {
return (ORF_R04_QUERY_RESPONSE)super.insertRepetition("QUERY_RESPONSE", rep);
}
/**
* Removes a specific repetition of QUERY_RESPONSE (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public ORF_R04_QUERY_RESPONSE removeQUERY_RESPONSE(int rep) throws HL7Exception {
return (ORF_R04_QUERY_RESPONSE)super.removeRepetition("QUERY_RESPONSE", rep);
}
/**
* 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 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
* QAK (Query Acknowledgment) - creates it if necessary
*/
public QAK getQAK() {
return getTyped("QAK", QAK.class);
}
/**
* Returns
* DSC (Continuation Pointer) - creates it if necessary
*/
public DSC getDSC() {
return getTyped("DSC", DSC.class);
}
}