cdac.medinfo.sdk.hl7282.baselibs

## Class MSG

- java.lang.Object
- - cdac.medinfo.sdk.hl7282.baselibs.CompositeDataType
  - - cdac.medinfo.sdk.hl7282.baselibs.MSG

- All Implemented Interfaces:
    IDataType

      public class MSG
      extends CompositeDataType

  MSG - Message Type

  This field contains the message type, trigger event, and the message structure ID for the message.

  Represents an HL7 MSG data type. This data type has the following attributes:

  1. Message Code (ID)Required
  2. Trigger Event (ID)Required
  3. Message Structure (ID)Required

  This class provides accessors & mutators for the elements mentioned above. This class override the equal method, to check whether some other object is "equal to" this one.

  User can also create Data Type through `DataElementFactory`

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `MSG()` Default Constructor for MSG
    `MSG(int iComponentType, IDataTypeMap objIDataTypeMap)` Constructor for MSG class which takes two arguments and sets the value in the respective member variable.
    `MSG(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, IDataTypeMap objIDataTypeMap)` Constructor for MSG class which takes five arguments and sets the value in the respective member variable.
    `MSG(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, int ITableNo, IDataTypeMap objIDataTypeMap)` Constructor for MSG class which takes six arguments and sets the value in the respective member variable.
    `MSG(int iMinLength, int iMaxLength, java.lang.String strCLength, int iComponentType)` Constructor for MSG class which takes four arguments and sets the value in the respective member variable.
    `MSG(int iMinLength, int iMaxLength, java.lang.String strCLength, int iTableNo, int iComponentType)` Constructor for MSG class which takes five arguments and sets the value in the respective member variable.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `equals(java.lang.Object objObject)` This method checks the equality of Object.
    `ID` | `getMessageCode()` The method gives the object of Tye ID
    `ID` | `getMessageStructure()` The method gives the object of Tye ID
    `ID` | `getTriggerEvent()` The method gives the object of Tye ID
    `void` | `setMessageCode(ID objID)` Sets the MessageCode.
    `void` | `setMessageCode(java.lang.String strMessageCode)` Sets the MessageCode.
    `void` | `setMessageStructure(ID objID)` Sets the MessageStructure.
    `void` | `setMessageStructure(java.lang.String strMessageStructure)` Sets the MessageStructure.
    `void` | `setTriggerEvent(ID objID)` Sets the TriggerEvent.
    `void` | `setTriggerEvent(java.lang.String strTriggerEvent)` Sets the TriggerEvent.
    `boolean` | `validate()` The Method validates the Input value,and if validated properly then returns true.

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

      `copy, dumpDataType, getAttributes, getDataTypeName, getLength, getValue, isPrimitive, read, setValue, write, writeToXML`

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

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

- - ### Constructor Detail

    - #### MSG

          public MSG()

      Default Constructor for MSG

    - #### MSG

          public MSG(int iMinLength,
             int iMaxLength,
             java.lang.String strCLength,
             int iComponentType)
              throws InvalidComponentTypeException

      Constructor for MSG class which takes four arguments and sets the value in the respective member variable.
      Parameters:
        `iMinLength` - The Minimum length the DataType can have.
        `iMaxLength` - The Maximum length the DataType can have.
        `iCLength` - The Conformance length the DataType can have.
        `iComponentType` - The Type of the component i.e Component or a subcomponent.
      Throws:
        `InvalidComponentTypeException` - - if Component Type is not specified or valid.

    - #### MSG

          public MSG(int iMinLength,
             int iMaxLength,
             java.lang.String strCLength,
             int iTableNo,
             int iComponentType)
              throws InvalidComponentTypeException

      Constructor for MSG class which takes five arguments and sets the value in the respective member variable.
      Parameters:
        `iMinLength` - The Minimum length the DataType can have.
        `iMaxLength` - The Maximum length the DataType can have.
        `iCLength` - The Conformance length the DataType can have.
        `iTableNo` - The Table number to which the value for the component is specified.
        `iComponentType` - The Type of the component i.e Component or a subcomponent.
      Throws:
        `InvalidComponentTypeException` - - if Component Type is not specified or valid.

    - #### MSG

          public MSG(int iComponentType,
             IDataTypeMap objIDataTypeMap)

      Constructor for MSG class which takes two arguments and sets the value in the respective member variable.
      Parameters:
        `objIDataTypeMap` - object of Data Type Map.
        `iComponentType` - The Type of the component i.e Component or a subcomponent.
      Throws:
        `InvalidComponentTypeException` - - if Component Type is not specified or valid.

    - #### MSG

          public MSG(int iComponentType,
             int iMinLength,
             int iMaxLength,
             java.lang.String strCLength,
             IDataTypeMap objIDataTypeMap)

      Constructor for MSG class which takes five arguments and sets the value in the respective member variable.
      Parameters:
        `objIDataTypeMap` - object of Data Type Map.
        `iComponentType` - The Type of the component i.e Component or a subcomponent.
        `iMinLength` - The Minimum length the DataType can have.
        `iMaxLength` - The Maximum length the DataType can have.
        `iCLength` - The Conformance length the DataType can have.
      Throws:
        `InvalidComponentTypeException` - - if Component Type is not specified or valid.

    - #### MSG

          public MSG(int iComponentType,
             int iMinLength,
             int iMaxLength,
             java.lang.String strCLength,
             int ITableNo,
             IDataTypeMap objIDataTypeMap)

      Constructor for MSG class which takes six arguments and sets the value in the respective member variable.
      Parameters:
        `objIDataTypeMap` - object of Data Type Map.
        `iComponentType` - The Type of the component i.e Component or a subcomponent.
        `iMinLength` - The Minimum length the DataType can have.
        `iMaxLength` - The Maximum length the DataType can have.
        `iCLength` - The Conformance length the DataType can have.
        `iTableNo` - The Table number to which the value for the component is specified.
      Throws:
        `InvalidComponentTypeException` - - if Component Type is not specified or valid.

  - ### Method Detail

    - #### setMessageCode

          public void setMessageCode(java.lang.String strMessageCode)

      Sets the MessageCode.
      Parameters:
        `strMessageCode` - Specifies the message type code.Suggested values such as ACK, ADT, ORM, ORU etc.

    - #### setMessageCode

          public void setMessageCode(ID objID)

      Sets the MessageCode.
      Parameters:
        `ID` - Specifies the message type code.Suggested values such as ACK, ADT, ORM, ORU etc.

    - #### setTriggerEvent

          public void setTriggerEvent(java.lang.String strTriggerEvent)

      Sets the TriggerEvent.
      Parameters:
        `strTriggerEvent` - Specifies the trigger event code.

    - #### setTriggerEvent

          public void setTriggerEvent(ID objID)

      Sets the TriggerEvent.
      Parameters:
        `objID` - Specifies the trigger event code.

    - #### setMessageStructure

          public void setMessageStructure(java.lang.String strMessageStructure)

      Sets the MessageStructure.
      Parameters:
        `strMessageStructure` - Specifies the abstract message structure code.

    - #### setMessageStructure

          public void setMessageStructure(ID objID)

      Sets the MessageStructure.
      Parameters:
        `objID` - Specifies the abstract message structure code.

    - #### getMessageCode

          public ID getMessageCode()

      The method gives the object of Tye ID
      Returns:
        ID - data type.

    - #### getTriggerEvent

          public ID getTriggerEvent()

      The method gives the object of Tye ID
      Returns:
        ID - data type.

    - #### getMessageStructure

          public ID getMessageStructure()

      The method gives the object of Tye ID
      Returns:
        ID - data type.

    - #### validate

          public boolean validate()
                           throws InvalidDataTypeException

      The Method validates the Input value,and if validated properly then returns true. Here the validetion is based on the compulsory fields for the Datatype.
      Specified by:
        `validate` in interface `IDataType`
      Overrides:
        `validate` in class `CompositeDataType`
      Returns:
        boolean - true or false.
      Throws:
        `InvalidDataTypeException` - - if Invalid values is entered or Mandatory field is missing.

    - #### equals

          public boolean equals(java.lang.Object objObject)

      This method checks the equality of Object.
      Overrides:
        `equals` in class `java.lang.Object`
      Parameters:
        `objObject` - object of Object class.
      Returns:
        boolean - shows success or failure of the comparison.