ca.uhn.hl7v2.model.v23.group.PPR_PC3_GOAL Maven / Gradle / Ivy
The newest version!
/*
* 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.v23.group;
import ca.uhn.hl7v2.model.v23.segment.*;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.model.*;
/**
* Represents a PPR_PC3_GOAL 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: GOL (Goal Detail)
* - 2: NTE (Notes and comments segment) optional repeating
* - 3: VAR (Variance) optional repeating
* - 4: PPR_PC3_GOAL_ROLE (a Group object) optional repeating
* - 5: PPR_PC3_GOAL_OBSERVATION (a Group object) optional repeating
*
*/
//@SuppressWarnings("unused")
public class PPR_PC3_GOAL extends AbstractGroup {
/**
* Creates a new PPR_PC3_GOAL group
*/
public PPR_PC3_GOAL(Group parent, ModelClassFactory factory) {
super(parent, factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(GOL.class, true, false, false);
this.add(NTE.class, false, true, false);
this.add(VAR.class, false, true, false);
this.add(PPR_PC3_GOAL_ROLE.class, false, true, false);
this.add(PPR_PC3_GOAL_OBSERVATION.class, false, true, false);
} catch(HL7Exception e) {
log.error("Unexpected error creating PPR_PC3_GOAL - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns "2.3"
*/
public String getVersion() {
return "2.3";
}
/**
* Returns
* GOL (Goal Detail) - creates it if necessary
*/
public GOL getGOL() {
GOL retVal = getTyped("GOL", GOL.class);
return retVal;
}
/**
* Returns
* the first repetition of
* NTE (Notes and comments segment) - creates it if necessary
*/
public NTE getNTE() {
NTE retVal = getTyped("NTE", NTE.class);
return retVal;
}
/**
* Returns a specific repetition of
* NTE (Notes and comments 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 NTE getNTE(int rep) {
NTE retVal = getTyped("NTE", rep, NTE.class);
return retVal;
}
/**
* Returns the number of existing repetitions of NTE
*/
public int getNTEReps() {
return getReps("NTE");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of NTE.
*
*
* Note that unlike {@link #getNTE()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public java.util.List getNTEAll() throws HL7Exception {
return getAllAsList("NTE", NTE.class);
}
/**
* Inserts a specific repetition of NTE (Notes and comments segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertNTE(NTE structure, int rep) throws HL7Exception {
super.insertRepetition("NTE", structure, rep);
}
/**
* Inserts a specific repetition of NTE (Notes and comments segment)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public NTE insertNTE(int rep) throws HL7Exception {
return (NTE)super.insertRepetition("NTE", rep);
}
/**
* Removes a specific repetition of NTE (Notes and comments segment)
* @see AbstractGroup#removeRepetition(String, int)
*/
public NTE removeNTE(int rep) throws HL7Exception {
return (NTE)super.removeRepetition("NTE", rep);
}
/**
* Returns
* the first repetition of
* VAR (Variance) - creates it if necessary
*/
public VAR getVAR() {
VAR retVal = getTyped("VAR", VAR.class);
return retVal;
}
/**
* Returns a specific repetition of
* VAR (Variance) - 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 VAR getVAR(int rep) {
VAR retVal = getTyped("VAR", rep, VAR.class);
return retVal;
}
/**
* Returns the number of existing repetitions of VAR
*/
public int getVARReps() {
return getReps("VAR");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of VAR.
*
*
* Note that unlike {@link #getVAR()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public java.util.List getVARAll() throws HL7Exception {
return getAllAsList("VAR", VAR.class);
}
/**
* Inserts a specific repetition of VAR (Variance)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertVAR(VAR structure, int rep) throws HL7Exception {
super.insertRepetition("VAR", structure, rep);
}
/**
* Inserts a specific repetition of VAR (Variance)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public VAR insertVAR(int rep) throws HL7Exception {
return (VAR)super.insertRepetition("VAR", rep);
}
/**
* Removes a specific repetition of VAR (Variance)
* @see AbstractGroup#removeRepetition(String, int)
*/
public VAR removeVAR(int rep) throws HL7Exception {
return (VAR)super.removeRepetition("VAR", rep);
}
/**
* Returns
* the first repetition of
* GOAL_ROLE (a Group object) - creates it if necessary
*/
public PPR_PC3_GOAL_ROLE getGOAL_ROLE() {
PPR_PC3_GOAL_ROLE retVal = getTyped("GOAL_ROLE", PPR_PC3_GOAL_ROLE.class);
return retVal;
}
/**
* Returns a specific repetition of
* GOAL_ROLE (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 PPR_PC3_GOAL_ROLE getGOAL_ROLE(int rep) {
PPR_PC3_GOAL_ROLE retVal = getTyped("GOAL_ROLE", rep, PPR_PC3_GOAL_ROLE.class);
return retVal;
}
/**
* Returns the number of existing repetitions of GOAL_ROLE
*/
public int getGOAL_ROLEReps() {
return getReps("GOAL_ROLE");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of GOAL_ROLE.
*
*
* Note that unlike {@link #getGOAL_ROLE()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public java.util.List getGOAL_ROLEAll() throws HL7Exception {
return getAllAsList("GOAL_ROLE", PPR_PC3_GOAL_ROLE.class);
}
/**
* Inserts a specific repetition of GOAL_ROLE (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertGOAL_ROLE(PPR_PC3_GOAL_ROLE structure, int rep) throws HL7Exception {
super.insertRepetition("GOAL_ROLE", structure, rep);
}
/**
* Inserts a specific repetition of GOAL_ROLE (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public PPR_PC3_GOAL_ROLE insertGOAL_ROLE(int rep) throws HL7Exception {
return (PPR_PC3_GOAL_ROLE)super.insertRepetition("GOAL_ROLE", rep);
}
/**
* Removes a specific repetition of GOAL_ROLE (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public PPR_PC3_GOAL_ROLE removeGOAL_ROLE(int rep) throws HL7Exception {
return (PPR_PC3_GOAL_ROLE)super.removeRepetition("GOAL_ROLE", rep);
}
/**
* Returns
* the first repetition of
* GOAL_OBSERVATION (a Group object) - creates it if necessary
*/
public PPR_PC3_GOAL_OBSERVATION getGOAL_OBSERVATION() {
PPR_PC3_GOAL_OBSERVATION retVal = getTyped("GOAL_OBSERVATION", PPR_PC3_GOAL_OBSERVATION.class);
return retVal;
}
/**
* Returns a specific repetition of
* GOAL_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 PPR_PC3_GOAL_OBSERVATION getGOAL_OBSERVATION(int rep) {
PPR_PC3_GOAL_OBSERVATION retVal = getTyped("GOAL_OBSERVATION", rep, PPR_PC3_GOAL_OBSERVATION.class);
return retVal;
}
/**
* Returns the number of existing repetitions of GOAL_OBSERVATION
*/
public int getGOAL_OBSERVATIONReps() {
return getReps("GOAL_OBSERVATION");
}
/**
*
* Returns a non-modifiable List containing all current existing repetitions of GOAL_OBSERVATION.
*
*
* Note that unlike {@link #getGOAL_OBSERVATION()}, this method will not create any reps
* if none are already present, so an empty list may be returned.
*
*/
public java.util.List getGOAL_OBSERVATIONAll() throws HL7Exception {
return getAllAsList("GOAL_OBSERVATION", PPR_PC3_GOAL_OBSERVATION.class);
}
/**
* Inserts a specific repetition of GOAL_OBSERVATION (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public void insertGOAL_OBSERVATION(PPR_PC3_GOAL_OBSERVATION structure, int rep) throws HL7Exception {
super.insertRepetition("GOAL_OBSERVATION", structure, rep);
}
/**
* Inserts a specific repetition of GOAL_OBSERVATION (a Group object)
* @see AbstractGroup#insertRepetition(Structure, int)
*/
public PPR_PC3_GOAL_OBSERVATION insertGOAL_OBSERVATION(int rep) throws HL7Exception {
return (PPR_PC3_GOAL_OBSERVATION)super.insertRepetition("GOAL_OBSERVATION", rep);
}
/**
* Removes a specific repetition of GOAL_OBSERVATION (a Group object)
* @see AbstractGroup#removeRepetition(String, int)
*/
public PPR_PC3_GOAL_OBSERVATION removeGOAL_OBSERVATION(int rep) throws HL7Exception {
return (PPR_PC3_GOAL_OBSERVATION)super.removeRepetition("GOAL_OBSERVATION", rep);
}
}