ca.uhn.hl7v2.model.v281.group.OSM_R26_SHIPMENT 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.v281.group;
import ca.uhn.hl7v2.model.v281.segment.*;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.model.*;
/**
* Represents a OSM_R26_SHIPMENT 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: SHP (Shipment)
* - 2: PRT (Participation Information) repeating
* - 3: OSM_R26_SHIPPING_OBSERVATION (a Group object) optional repeating
* - 4: OSM_R26_PACKAGE (a Group object) repeating
*
*/
//@SuppressWarnings("unused")
public class OSM_R26_SHIPMENT extends AbstractGroup {
/**
* Creates a new OSM_R26_SHIPMENT group
*/
public OSM_R26_SHIPMENT(Group parent, ModelClassFactory factory) {
super(parent, factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(SHP.class, true, false, false);
this.add(PRT.class, true, true, false);
this.add(OSM_R26_SHIPPING_OBSERVATION.class, false, true, false);
this.add(OSM_R26_PACKAGE.class, true, true, false);
} catch(HL7Exception e) {
log.error("Unexpected error creating OSM_R26_SHIPMENT - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.8.1"
*/
public String getVersion() {
return "2.8.1";
}
/**
* Returns
* SHP (Shipment) - creates it if necessary
*/
public SHP getSHP() {
SHP retVal = getTyped("SHP", SHP.class);
return retVal;
}
/**
* Returns
* the first repetition of
* PRT (Participation Information) - creates it if necessary
*/
public PRT getPRT() {
PRT retVal = getTyped("PRT", PRT.class);
return retVal;
}
/**
* Returns a specific repetition of
* PRT (Participation Information) - 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 PRT getPRT(int rep) {
PRT retVal = getTyped("PRT", rep, PRT.class);
return retVal;
}
/**
* Returns the number of existing repetitions of PRT
*/
public int getPRTReps() {
return getReps("PRT");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of PRT.
*
*
* Note that unlike {@link #getPRT()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public java.util.List getPRTAll() throws HL7Exception {
return getAllAsList("PRT", PRT.class);
}
/**
* Inserts a specific repetition of PRT (Participation Information)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertPRT(PRT structure, int rep) throws HL7Exception {
super.insertRepetition("PRT", structure, rep);
}
/**
* Inserts a specific repetition of PRT (Participation Information)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public PRT insertPRT(int rep) throws HL7Exception {
return (PRT)super.insertRepetition("PRT", rep);
}
/**
* Removes a specific repetition of PRT (Participation Information)
* @see AbstractGroup#removeRepetition(String, int)
*/
public PRT removePRT(int rep) throws HL7Exception {
return (PRT)super.removeRepetition("PRT", rep);
}
/**
* Returns
* the first repetition of
* SHIPPING_OBSERVATION (a Group object) - creates it if necessary
*/
public OSM_R26_SHIPPING_OBSERVATION getSHIPPING_OBSERVATION() {
OSM_R26_SHIPPING_OBSERVATION retVal = getTyped("SHIPPING_OBSERVATION", OSM_R26_SHIPPING_OBSERVATION.class);
return retVal;
}
/**
* Returns a specific repetition of
* SHIPPING_OBSERVATION (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 OSM_R26_SHIPPING_OBSERVATION getSHIPPING_OBSERVATION(int rep) {
OSM_R26_SHIPPING_OBSERVATION retVal = getTyped("SHIPPING_OBSERVATION", rep, OSM_R26_SHIPPING_OBSERVATION.class);
return retVal;
}
/**
* Returns the number of existing repetitions of SHIPPING_OBSERVATION
*/
public int getSHIPPING_OBSERVATIONReps() {
return getReps("SHIPPING_OBSERVATION");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of SHIPPING_OBSERVATION.
*
*
* Note that unlike {@link #getSHIPPING_OBSERVATION()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public java.util.List getSHIPPING_OBSERVATIONAll() throws HL7Exception {
return getAllAsList("SHIPPING_OBSERVATION", OSM_R26_SHIPPING_OBSERVATION.class);
}
/**
* Inserts a specific repetition of SHIPPING_OBSERVATION (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertSHIPPING_OBSERVATION(OSM_R26_SHIPPING_OBSERVATION structure, int rep) throws HL7Exception {
super.insertRepetition("SHIPPING_OBSERVATION", structure, rep);
}
/**
* Inserts a specific repetition of SHIPPING_OBSERVATION (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public OSM_R26_SHIPPING_OBSERVATION insertSHIPPING_OBSERVATION(int rep) throws HL7Exception {
return (OSM_R26_SHIPPING_OBSERVATION)super.insertRepetition("SHIPPING_OBSERVATION", rep);
}
/**
* Removes a specific repetition of SHIPPING_OBSERVATION (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public OSM_R26_SHIPPING_OBSERVATION removeSHIPPING_OBSERVATION(int rep) throws HL7Exception {
return (OSM_R26_SHIPPING_OBSERVATION)super.removeRepetition("SHIPPING_OBSERVATION", rep);
}
/**
* Returns
* the first repetition of
* PACKAGE (a Group object) - creates it if necessary
*/
public OSM_R26_PACKAGE getPACKAGE() {
OSM_R26_PACKAGE retVal = getTyped("PACKAGE", OSM_R26_PACKAGE.class);
return retVal;
}
/**
* Returns a specific repetition of
* PACKAGE (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 OSM_R26_PACKAGE getPACKAGE(int rep) {
OSM_R26_PACKAGE retVal = getTyped("PACKAGE", rep, OSM_R26_PACKAGE.class);
return retVal;
}
/**
* Returns the number of existing repetitions of PACKAGE
*/
public int getPACKAGEReps() {
return getReps("PACKAGE");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of PACKAGE.
*
*
* Note that unlike {@link #getPACKAGE()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public java.util.List getPACKAGEAll() throws HL7Exception {
return getAllAsList("PACKAGE", OSM_R26_PACKAGE.class);
}
/**
* Inserts a specific repetition of PACKAGE (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertPACKAGE(OSM_R26_PACKAGE structure, int rep) throws HL7Exception {
super.insertRepetition("PACKAGE", structure, rep);
}
/**
* Inserts a specific repetition of PACKAGE (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public OSM_R26_PACKAGE insertPACKAGE(int rep) throws HL7Exception {
return (OSM_R26_PACKAGE)super.insertRepetition("PACKAGE", rep);
}
/**
* Removes a specific repetition of PACKAGE (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public OSM_R26_PACKAGE removePACKAGE(int rep) throws HL7Exception {
return (OSM_R26_PACKAGE)super.removeRepetition("PACKAGE", rep);
}
}