cdac.medinfo.sdk.hl7282.hl7model.messages.personnelmanagement

## Class PMU_B08

- java.lang.Object
- - cdac.medinfo.sdk.hl7282.baselibs.messages.Message
  - - cdac.medinfo.sdk.hl7282.hl7model.messages.personnelmanagement.PMU_B08

-     public final class PMU_B08
      extends Message

  PMU_B08 - Grant Certificate/Permission (Event B08). This message is use to indicates that a certificate/permission for a health professional is revoked.

  Represents a PMU_B08 message structure (see chapter 15.3.9). This structure contains the following elements:

  0: MSH (Message Header Segment) SINGLE_COMPULSARY
  1: SFT (Software Segment) MULTIPLE_OPTIONAL
  2: UAC (User Authentication Credential) SINGLE_OPTIONAL
  3: EVN (Event Type Segment) SINGLE_COMPULSARY
  4: STF (Staff Identification Segment) SINGLE_COMPULSARY
  5: PRA (Practitioner Detail Segment) SINGLE_OPTIONAL
  6: CER (Certificate 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.

  PMU_B08 objB08 = (PMU_B08)MessageFactory.createInstance().createSendSupportedMessage("PMU", "B08");

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addCertificateSegment(CER objCER)` Adds Certificate Segment(CER) to this message.
    `void` | `addCertificateSegments(ISingleCollection<CER> objCERSegmentCollection)` Adds collection of Certificate Segment(CER) 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.
    `ISingleCollection<CER>` | `getCertificateSegments()` Retrieves Collection of Certificate Segments(CER) present in this message.
    `EVN` | `getEventTypeSegment()` Retrieves Event Type(EVN) segment present in this message
    `PRA` | `getPractitionerSegment()` Retrieves Collection of Practitioner Segments(PRA) present in this message.
    `ISingleCollection<SFT>` | `getSoftwareSegments()` Retrieves Collection of Software Segments(SFT) present in this message.
    `STF` | `getStaffTypeSegment()` Retrieves Staff(STF) segment present in this message
    `UAC` | `getUserAuthenticationCredentialSegment()` Retrieves User Authentication Credential(UAC) segment present in this message
    `void` | `setEventTypeSegment(EVN objEVN)` Sets value of Event Type segment for this message,overwrites if already present.
    `void` | `setPractitionerSegment(PRA objPRA)` Adds Practitioner Segment(PRA) to this message.
    `void` | `setStaffSegment(STF objSTF)` Sets value of Staff 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

    - #### getEventTypeSegment

          public EVN getEventTypeSegment()

      Retrieves Event Type(EVN) segment present in this message
      Returns:
        EVN - the EVN Segment present in this message or null if unavailable.

    - #### setEventTypeSegment

          public void setEventTypeSegment(EVN objEVN)

      Sets value of Event Type segment for this message,overwrites if already present.
      Parameters:
        `objEVN` - Specified EVN Segment

    - #### setStaffSegment

          public void setStaffSegment(STF objSTF)

      Sets value of Staff segment for this message,overwrites if already present.
      Parameters:
        `objSTF` - Specified Staff Segment

    - #### getStaffTypeSegment

          public STF getStaffTypeSegment()

      Retrieves Staff(STF) segment present in this message
      Returns:
        STF - the STF Segment present in this message or null if unavailable.

    - #### getPractitionerSegment

          public PRA getPractitionerSegment()

      Retrieves Collection of Practitioner Segments(PRA) present in this message.
      Returns:
        ISingleCollection - Collection of Practitioner Segments(PRA) present in this message.

    - #### setPractitionerSegment

          public void setPractitionerSegment(PRA objPRA)

      Adds Practitioner Segment(PRA) to this message.
      Parameters:
        `objPRA` - Specified Practitioner Segment(PRA)

    - #### getCertificateSegments

          public ISingleCollection<CER> getCertificateSegments()

      Retrieves Collection of Certificate Segments(CER) present in this message.
      Returns:
        ISingleCollection - Collection of Certificate Segments(CER) present in this message.

    - #### addCertificateSegment

          public void addCertificateSegment(CER objCER)

      Adds Certificate Segment(CER) to this message.
      Parameters:
        `objCER` - Specified Certificate Segment(CER)

    - #### addCertificateSegments

          public void addCertificateSegments(ISingleCollection<CER> objCERSegmentCollection)

      Adds collection of Certificate Segment(CER) to this message.
      Parameters:
        `objCERSegmentCollection` - Collection of Certificate Segments