cdac.medinfo.sdk.hl7282.hl7model.messages.clinicallaboratoryautomation

## Class ESU_U01

- java.lang.Object
- - cdac.medinfo.sdk.hl7282.baselibs.messages.Message
  - - cdac.medinfo.sdk.hl7282.hl7model.messages.clinicallaboratoryautomation.ESU_U01

-     public final class ESU_U01
      extends Message

  ESU_U01 - Automated Equipment Status Update (Event U01). This message is use to sent information about the status of a device or equipment from one application to another (e.g., automated device to a Laboratory Automation System).

  Represents a ESU_U01 message structure (see chapter 13.3.1). This structure contains the following elements:

  0: MSH (Message Header Segment) SINGLE_COMPULSARY
  1: SFT (Software Segment) MULTIPLE_OPTIONAL
  2: UAC (User Authentication Credential Segment) SINGLE_OPTIONAL
  2: EQU (Equipment Detail Segment) SINGLE_COMPULSARY
  3: ISD (Interaction Status Detail Segment) MULTIPLE_OPTIONAL
  This class provides mechanism to validate message against HL7 v 2.8.2 standard. The class provides accessors & mutators for the elements mentioned above. These elements can be easily populated & populated values can be easily retrieved. The class has validate method which validates Message against HL7 v 2.8.2 standard.

  Following is the step to create message
  Before that, respective Message Source and Message Recipient to be set on Message Factory.

  ESU_U01 objU01 = (ESU_U01)MessageFactory.createInstance().createSendSupportedMessage("ESU", "U01");

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addInteractionStatusDetail(ISD objISD)` Adds Interaction Status Detail(ISD) to this message.
    `void` | `addInteractionStatusDetail(ISingleCollection<ISD> objISDSegmentCollection)` Adds collection of Interaction Status Detail(ISD) to this message.
    `void` | `addSoftwareSegment(ISingleCollection<SFT> objSFTSegmentCollection)` Adds collection of Software Segment(SFT) to this message.
    `void` | `addSoftwareSegment(SFT objSFT)` Adds Software Segment(SFT) to this message.
    `EQU` | `getEquipmentDetailSegment()` Retrieves Equipment Detail(EQU) segment present in this message
    `ISingleCollection<ISD>` | `getInteractionStatusDetail()` Retrieves Interaction Status Detail(ISD) present in this message.
    `ISingleCollection<SFT>` | `getSoftwareSegments()` Retrieves Collection of Software Segments(SFT) present in this message.
    `UAC` | `getUserAuthenticationCredentialSegment()` Retrieves User Authentication Credential(UAC) segment present in this message
    `void` | `setEquipmentDetailSegment(EQU objEQU)` Sets value of Equipment Detail segment for this message,overwrites if already present.
    `void` | `setUserAuthenticationCredentialSegment(UAC objUAC)` Sets value of User Authentication Credential(UAC) segment for this message, overwrites if already present.

    - ### Methods inherited from class cdac.medinfo.sdk.hl7282.baselibs.messages.Message

      `contains, dumpMessage, dumpMessage, getACKMode, getGroup, getGroupMap, getHeader, getMessageCode, getMessageControlID, getMessageStructure, getQueryUserParameters, getSegment, getSegmentSet, getSubscriptionType, getTriggerEvent, isQuery, isResponse, populate, removeGroup, removeSegment, removeSegment, removeSegmentAttribute, removeSegmentAttribute, removeSegmentAttribute, removeSegments, setHeader, setSubscriptionType, updateSegmentAttribute, updateSegmentAttribute, validate, writeToXML, writeToXML`

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### getSoftwareSegments

          public ISingleCollection<SFT> getSoftwareSegments()

      Retrieves Collection of Software Segments(SFT) present in this message.
      Returns:
        ISingleCollection - Collection of Software Segments(SFT) present in this message.

    - #### addSoftwareSegment

          public void addSoftwareSegment(SFT objSFT)

      Adds Software Segment(SFT) to this message.
      Parameters:
        `objSFT` - Specified Software Segment(SFT) to be added in this messageto this message.

    - #### addSoftwareSegment

          public void addSoftwareSegment(ISingleCollection<SFT> objSFTSegmentCollection)

      Adds collection of Software Segment(SFT) to this message.
      Parameters:
        `objSFTSegmentCollection` - Collection of Software Segments to add in this message

    - #### getUserAuthenticationCredentialSegment

          public UAC getUserAuthenticationCredentialSegment()

      Retrieves User Authentication Credential(UAC) segment present in this message
      Returns:
        UAC - the User Authentication Credential Segment present in this message or null if unavailable.

    - #### setUserAuthenticationCredentialSegment

          public void setUserAuthenticationCredentialSegment(UAC objUAC)

      Sets value of User Authentication Credential(UAC) segment for this message, overwrites if already present.
      Parameters:
        `objUAC` - Specified UAC Segment

    - #### getEquipmentDetailSegment

          public EQU getEquipmentDetailSegment()

      Retrieves Equipment Detail(EQU) segment present in this message
      Returns:
        EQU - the EQU Segment present in this message or null if unavailable.

    - #### setEquipmentDetailSegment

          public void setEquipmentDetailSegment(EQU objEQU)

      Sets value of Equipment Detail segment for this message,overwrites if already present.
      Parameters:
        `objEQU` - Specified EQU Segment

    - #### getInteractionStatusDetail

          public ISingleCollection<ISD> getInteractionStatusDetail()

      Retrieves Interaction Status Detail(ISD) present in this message.
      Returns:
        ISingleCollection - Collection of Interaction Status Detail(ISD) segment present in this message.

    - #### addInteractionStatusDetail

          public void addInteractionStatusDetail(ISD objISD)

      Adds Interaction Status Detail(ISD) to this message.
      Parameters:
        `objISD` - Specified Interaction Status Detail(ISD) to this message.

    - #### addInteractionStatusDetail

          public void addInteractionStatusDetail(ISingleCollection<ISD> objISDSegmentCollection)

      Adds collection of Interaction Status Detail(ISD) to this message.
      Parameters:
        `objISDSegmentCollection` - Collection of Interaction Status Detail(ISD) segments to add in this message