ca.uhn.hl7v2.model.v25.segment.ECD 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/
*/
package ca.uhn.hl7v2.model.v25.segment;
// import ca.uhn.hl7v2.model.v25.group.*;
import ca.uhn.hl7v2.model.v25.datatype.*;
import ca.uhn.log.HapiLogFactory;
import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.parser.ModelClassFactory;
import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
import ca.uhn.hl7v2.model.AbstractMessage;
import ca.uhn.hl7v2.model.Group;
import ca.uhn.hl7v2.model.Type;
import ca.uhn.hl7v2.model.AbstractSegment;
import ca.uhn.hl7v2.model.Varies;
/**
*Represents an HL7 ECD message segment (Equipment Command).
* This segment has the following fields:
*
* - ECD-1: Reference Command Number (NM)
*
- ECD-2: Remote Control Command (CE)
*
- ECD-3: Response Required (ID) optional
*
- ECD-4: Requested Completion Time (TQ) optional
*
- ECD-5: Parameters (TX) optional repeating
*
*/
public class ECD extends AbstractSegment {
/**
* Creates a new ECD segment
*/
public ECD(Group parent, ModelClassFactory factory) {
super(parent, factory);
init(factory);
}
private void init(ModelClassFactory factory) {
try {
this.add(NM.class, true, 1, 20, new Object[]{ getMessage(), new Integer(0) }, "Reference Command Number");
this.add(CE.class, true, 1, 250, new Object[]{ getMessage(), new Integer(368) }, "Remote Control Command");
this.add(ID.class, false, 1, 80, new Object[]{ getMessage() }, "Response Required");
this.add(TQ.class, false, 1, 200, new Object[]{ getMessage(), new Integer(0) }, "Requested Completion Time");
this.add(TX.class, false, 0, 65536, new Object[]{ getMessage(), new Integer(0) }, "Parameters");
} catch(HL7Exception e) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error creating ECD - this is probably a bug in the source code generator.", e);
}
}
/**
* Returns
* ECD-1: "Reference Command Number" - creates it if necessary
*/
public NM getReferenceCommandNumber() {
NM ret = null;
try {
Type t = this.getField(1, 0);
ret = (NM)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns
* ECD-1: "Reference Command Number" - creates it if necessary
*/
public NM getEcd1_ReferenceCommandNumber() {
NM ret = null;
try {
Type t = this.getField(1, 0);
ret = (NM)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns
* ECD-2: "Remote Control Command" - creates it if necessary
*/
public CE getRemoteControlCommand() {
CE ret = null;
try {
Type t = this.getField(2, 0);
ret = (CE)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns
* ECD-2: "Remote Control Command" - creates it if necessary
*/
public CE getEcd2_RemoteControlCommand() {
CE ret = null;
try {
Type t = this.getField(2, 0);
ret = (CE)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns
* ECD-3: "Response Required" - creates it if necessary
*/
public ID getResponseRequired() {
ID ret = null;
try {
Type t = this.getField(3, 0);
ret = (ID)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns
* ECD-3: "Response Required" - creates it if necessary
*/
public ID getEcd3_ResponseRequired() {
ID ret = null;
try {
Type t = this.getField(3, 0);
ret = (ID)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns
* ECD-4: "Requested Completion Time" - creates it if necessary
*/
public TQ getRequestedCompletionTime() {
TQ ret = null;
try {
Type t = this.getField(4, 0);
ret = (TQ)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns
* ECD-4: "Requested Completion Time" - creates it if necessary
*/
public TQ getEcd4_RequestedCompletionTime() {
TQ ret = null;
try {
Type t = this.getField(4, 0);
ret = (TQ)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns all repetitions of Parameters (ECD-5).
*/
public TX[] getParameters() {
TX[] ret = null;
try {
Type[] t = this.getField(5);
ret = new TX[t.length];
for (int i = 0; i < ret.length; i++) {
ret[i] = (TX)t[i];
}
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns a count of the current number of repetitions of Parameters (ECD-5).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getParametersReps() {
TX[] ret = null;
try {
Type[] t = this.getField(5);
return t.length;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
}
/**
* Returns a specific repetition of
* ECD-5: "Parameters" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public TX getParameters(int rep) {
TX ret = null;
try {
Type t = this.getField(5, rep);
ret = (TX)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns a specific repetition of
* ECD-5: "Parameters" - creates it if necessary
*
* @param rep The repetition index (0-indexed)
*/
public TX getEcd5_Parameters(int rep) {
TX ret = null;
try {
Type t = this.getField(5, rep);
ret = (TX)t;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
return ret;
}
/**
* Returns a count of the current number of repetitions of Parameters (ECD-5).
* This method does not create a repetition, so if no repetitions have currently been defined or accessed,
* it will return zero.
*/
public int getEcd5_ParametersReps() {
TX[] ret = null;
try {
Type[] t = this.getField(5);
return t.length;
} catch (ClassCastException cce) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
throw new RuntimeException(cce);
} catch (HL7Exception he) {
HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
throw new RuntimeException(he);
}
}
/**
* Inserts a repetition of
* ECD-5: "Parameters" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public TX insertParameters(int rep) throws HL7Exception {
return (TX) super.insertRepetition(5, rep);
}
/**
* Inserts a repetition of
* ECD-5: "Parameters" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public TX insertEcd5_Parameters(int rep) throws HL7Exception {
return (TX) super.insertRepetition(5, rep);
}
/**
* Removes a repetition of
* ECD-5: "Parameters" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public TX removeParameters(int rep) throws HL7Exception {
return (TX) super.removeRepetition(5, rep);
}
/**
* Removes a repetition of
* ECD-5: "Parameters" at a specific index
*
* @param rep The repetition index (0-indexed)
* @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
*/
public TX removeEcd5_Parameters(int rep) throws HL7Exception {
return (TX) super.removeRepetition(5, rep);
}
/** {@inheritDoc} */
protected Type createNewTypeWithoutReflection(int field) {
switch (field) {
case 0: return new NM(getMessage());
case 1: return new CE(getMessage());
case 2: return new ID(getMessage(), new Integer( 136 ));
case 3: return new TQ(getMessage());
case 4: return new TX(getMessage());
default: return null;
}
}
}