Package ca.uhn.hl7v2.model.v22.segment

Class BTS

java.lang.Object
ca.uhn.hl7v2.model.AbstractStructure
ca.uhn.hl7v2.model.AbstractSegment
ca.uhn.hl7v2.model.v22.segment.BTS
All Implemented Interfaces:
Segment, Structure, Visitable, 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 (CM_BATCH_TOTAL) optional repeating
See Also:

  • Constructor Details

  • Method Details

    • 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 CM_BATCH_TOTAL[] getBatchTotals()
      Returns all repetitions of Batch Totals (BTS-3).

    • getBts3_BatchTotals

      public CM_BATCH_TOTAL[] getBts3_BatchTotals()
      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 CM_BATCH_TOTAL 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 CM_BATCH_TOTAL 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 CM_BATCH_TOTAL 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 CM_BATCH_TOTAL 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 CM_BATCH_TOTAL 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 CM_BATCH_TOTAL 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