ca.uhn.hl7v2.model.v24.segment
Class ECD

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.ECD

All Implemented Interfaces:

Segment, Structure, Serializable

public class ECD
extends AbstractSegment

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 (ST) optional repeating

See Also:

Serialized Form

Constructor Summary

ECD(Group parent, ModelClassFactory factory)
Creates a new ECD segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
NM	getEcd1_ReferenceCommandNumber() Returns ECD-1: "Reference Command Number" - creates it if necessary
CE	getEcd2_RemoteControlCommand() Returns ECD-2: "Remote Control Command" - creates it if necessary
ID	getEcd3_ResponseRequired() Returns ECD-3: "Response Required" - creates it if necessary
TQ	getEcd4_RequestedCompletionTime() Returns ECD-4: "Requested Completion Time" - creates it if necessary
ST	getEcd5_Parameters(int rep) Returns a specific repetition of ECD-5: "Parameters" - creates it if necessary
int	getEcd5_ParametersReps() Returns a count of the current number of repetitions of Parameters (ECD-5).
ST[]	getParameters() Returns all repetitions of Parameters (ECD-5).
ST	getParameters(int rep) Returns a specific repetition of ECD-5: "Parameters" - creates it if necessary
int	getParametersReps() Returns a count of the current number of repetitions of Parameters (ECD-5).
NM	getReferenceCommandNumber() Returns ECD-1: "Reference Command Number" - creates it if necessary
CE	getRemoteControlCommand() Returns ECD-2: "Remote Control Command" - creates it if necessary
TQ	getRequestedCompletionTime() Returns ECD-4: "Requested Completion Time" - creates it if necessary
ID	getResponseRequired() Returns ECD-3: "Response Required" - creates it if necessary
ST	insertEcd5_Parameters(int rep) Inserts a repetition of ECD-5: "Parameters" at a specific index
ST	insertParameters(int rep) Inserts a repetition of ECD-5: "Parameters" at a specific index
ST	removeEcd5_Parameters(int rep) Removes a repetition of ECD-5: "Parameters" at a specific index
ST	removeParameters(int rep) Removes a repetition of ECD-5: "Parameters" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ECD

public ECD(Group parent,
           ModelClassFactory factory)

Creates a new ECD segment

Method Detail

getReferenceCommandNumber

public NM getReferenceCommandNumber()

Returns ECD-1: "Reference Command Number" - creates it if necessary

getEcd1_ReferenceCommandNumber

public NM getEcd1_ReferenceCommandNumber()

Returns ECD-1: "Reference Command Number" - creates it if necessary

getRemoteControlCommand

public CE getRemoteControlCommand()

Returns ECD-2: "Remote Control Command" - creates it if necessary

getEcd2_RemoteControlCommand

public CE getEcd2_RemoteControlCommand()

Returns ECD-2: "Remote Control Command" - creates it if necessary

getResponseRequired

public ID getResponseRequired()

Returns ECD-3: "Response Required" - creates it if necessary

getEcd3_ResponseRequired

public ID getEcd3_ResponseRequired()

Returns ECD-3: "Response Required" - creates it if necessary

getRequestedCompletionTime

public TQ getRequestedCompletionTime()

Returns ECD-4: "Requested Completion Time" - creates it if necessary

getEcd4_RequestedCompletionTime

public TQ getEcd4_RequestedCompletionTime()

Returns ECD-4: "Requested Completion Time" - creates it if necessary

getParameters

public ST[] getParameters()

Returns all repetitions of Parameters (ECD-5).

getParametersReps

public int getParametersReps()

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.

getParameters

public ST getParameters(int rep)

Returns a specific repetition of ECD-5: "Parameters" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getEcd5_Parameters

public ST getEcd5_Parameters(int rep)

Returns a specific repetition of ECD-5: "Parameters" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getEcd5_ParametersReps

public int getEcd5_ParametersReps()

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.

insertParameters

public ST insertParameters(int rep)
                    throws HL7Exception

Inserts a repetition of ECD-5: "Parameters" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertEcd5_Parameters

public ST insertEcd5_Parameters(int rep)
                         throws HL7Exception

Inserts a repetition of ECD-5: "Parameters" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeParameters

public ST removeParameters(int rep)
                    throws HL7Exception

Removes a repetition of ECD-5: "Parameters" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeEcd5_Parameters

public ST removeEcd5_Parameters(int rep)
                         throws HL7Exception

Removes a repetition of ECD-5: "Parameters" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment