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

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

All Implemented Interfaces:

Segment, Structure, Serializable

public class BTS
extends AbstractSegment

Represents an HL7 BTS message segment (Batch Trailer). This segment has the following fields:

• BTS-1: Batch Message Count (ST) optional
• BTS-2: Batch Comment (ST) optional
• BTS-3: Batch Totals (NM) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
ST	getBatchComment() Returns BTS-2: "Batch Comment" - creates it if necessary
ST	getBatchMessageCount() Returns BTS-1: "Batch Message Count" - creates it if necessary
NM[]	getBatchTotals() Returns all repetitions of Batch Totals (BTS-3).
NM	getBatchTotals(int rep) Returns a specific repetition of BTS-3: "Batch Totals" - creates it if necessary
int	getBatchTotalsReps() Returns a count of the current number of repetitions of Batch Totals (BTS-3).
ST	getBts1_BatchMessageCount() Returns BTS-1: "Batch Message Count" - creates it if necessary
ST	getBts2_BatchComment() Returns BTS-2: "Batch Comment" - creates it if necessary
NM	getBts3_BatchTotals(int rep) Returns a specific repetition of BTS-3: "Batch Totals" - creates it if necessary
int	getBts3_BatchTotalsReps() Returns a count of the current number of repetitions of Batch Totals (BTS-3).
NM	insertBatchTotals(int rep) Inserts a repetition of BTS-3: "Batch Totals" at a specific index
NM	insertBts3_BatchTotals(int rep) Inserts a repetition of BTS-3: "Batch Totals" at a specific index
NM	removeBatchTotals(int rep) Removes a repetition of BTS-3: "Batch Totals" at a specific index
NM	removeBts3_BatchTotals(int rep) Removes a repetition of BTS-3: "Batch Totals" 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

BTS

public BTS(Group parent,
           ModelClassFactory factory)

Creates a new BTS segment

Method Detail

getBatchMessageCount

public ST getBatchMessageCount()

Returns BTS-1: "Batch Message Count" - creates it if necessary

getBts1_BatchMessageCount

public ST getBts1_BatchMessageCount()

Returns BTS-1: "Batch Message Count" - creates it if necessary

getBatchComment

public ST getBatchComment()

Returns BTS-2: "Batch Comment" - creates it if necessary

getBts2_BatchComment

public ST getBts2_BatchComment()

Returns BTS-2: "Batch Comment" - creates it if necessary

getBatchTotals

public NM[] getBatchTotals()

Returns all repetitions of Batch Totals (BTS-3).

getBatchTotalsReps

public int getBatchTotalsReps()

Returns a count of the current number of repetitions of Batch Totals (BTS-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getBatchTotals

public NM getBatchTotals(int rep)

Returns a specific repetition of BTS-3: "Batch Totals" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getBts3_BatchTotals

public NM getBts3_BatchTotals(int rep)

Returns a specific repetition of BTS-3: "Batch Totals" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getBts3_BatchTotalsReps

public int getBts3_BatchTotalsReps()

Returns a count of the current number of repetitions of Batch Totals (BTS-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertBatchTotals

public NM insertBatchTotals(int rep)
                     throws HL7Exception

Inserts a repetition of BTS-3: "Batch Totals" 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)

insertBts3_BatchTotals

public NM insertBts3_BatchTotals(int rep)
                          throws HL7Exception

Inserts a repetition of BTS-3: "Batch Totals" 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)

removeBatchTotals

public NM removeBatchTotals(int rep)
                     throws HL7Exception

Removes a repetition of BTS-3: "Batch Totals" 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)

removeBts3_BatchTotals

public NM removeBts3_BatchTotals(int rep)
                          throws HL7Exception

Removes a repetition of BTS-3: "Batch Totals" 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