cdac.medinfo.sdk.hl7282.baselibs

## Class AUI

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

- All Implemented Interfaces:
    IDataType

      public class AUI
      extends CompositeDataType

  AUI - Authorization Information

  This data type specifies the identifier or code for an insurance authorization instance and its associated detail.

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

  1. authorization number (ST)Optional
  2. date (DT)Optional
  3. source (ST)Optional

  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
    `AUI()` Default Constructor for AUI
    `AUI(int iComponentType, IDataTypeMap objIDataTypeMap)` Constructor for AUI class which takes two arguments and sets the value in the respective member variable.
    `AUI(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, IDataTypeMap objIDataTypeMap)` Constructor for AUI class which takes five arguments and sets the value in the respective member variable.
    `AUI(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, int ITableNo, IDataTypeMap objIDataTypeMap)` Constructor for AUI class which takes six arguments and sets the value in the respective member variable.
    `AUI(int iMinLength, int iMaxLength, java.lang.String strCLength, int iComponentType)` Constructor for AUI class which takes four arguments and sets the value in the respective member variable.
    `AUI(int iMinLength, int iMaxLength, java.lang.String strCLength, int iTableNo, int iComponentType)` Constructor for AUI 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.
    `ST` | `getAuthorizationNumber()` Returns Authorization Number
    `DT` | `getDate()` Returns Date
    `ST` | `getSource()` Returns Source
    `void` | `setAuthorizationNumber(ST objST)` Sets the Authorization Number.
    `void` | `setAuthorizationNumber(java.lang.String strAuthorizationNumber)` Sets the Authorization Number.
    `void` | `setDate(DT objDT)` Sets the Date.
    `void` | `setDate(java.lang.String strDate)` Sets the Date.
    `void` | `setSource(ST objST)` sets the Source.
    `void` | `setSource(java.lang.String strSource)` sets the Source.

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

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

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

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

- - ### Constructor Detail

    - #### AUI

          public AUI()

      Default Constructor for AUI

    - #### AUI

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

      Constructor for AUI 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.

    - #### AUI

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

      Constructor for AUI 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.

    - #### AUI

          public AUI(int iComponentType,
             IDataTypeMap objIDataTypeMap)

      Constructor for AUI 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.

    - #### AUI

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

      Constructor for AUI 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.

    - #### AUI

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

      Constructor for AUI 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

    - #### setAuthorizationNumber

          public void setAuthorizationNumber(java.lang.String strAuthorizationNumber)

      Sets the Authorization Number.
      Parameters:
        `strAuthorizationNumber` - Specifies Identifier assigned to the authorization.

    - #### setAuthorizationNumber

          public void setAuthorizationNumber(ST objST)

      Sets the Authorization Number.
      Parameters:
        `objST` - Specifies Identifier assigned to the authorization.

    - #### setDate

          public void setDate(java.lang.String strDate)

      Sets the Date.
      Parameters:
        `strDate` - specifies Date of authorization.

    - #### setDate

          public void setDate(DT objDT)

      Sets the Date.
      Parameters:
        `objDT` - specifies Date of authorization.

    - #### setSource

          public void setSource(java.lang.String strSource)

      sets the Source.
      Parameters:
        `strSource` - Specifies Source of authorization.

    - #### setSource

          public void setSource(ST objST)

      sets the Source.
      Parameters:
        `objST` - Specifies Source of authorization.

    - #### getAuthorizationNumber

          public ST getAuthorizationNumber()

      Returns Authorization Number
      Returns:
        ST - data type.

    - #### getDate

          public DT getDate()

      Returns Date
      Returns:
        DT - data type.

    - #### getSource

          public ST getSource()

      Returns Source
      Returns:
        ST - data type.

    - #### 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.