cdac.medinfo.sdk.hl7282.baselibs

## Class PTA

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

- All Implemented Interfaces:
    IDataType

      public class PTA
      extends CompositeDataType

  PTA - Policy type and amount

  This data type specifies the policy type and amount covered by the insurance.

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

  1. Policy Type (CWE)Required
  2. Amount Class (CWE)Optional
  4. Money or Percentage (MOP)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
    `PTA()` Default Constructor for PTA
    `PTA(int iComponentType, IDataTypeMap objIDataTypeMap)` Constructor for PTA class which takes two arguments and sets the value in the respective member variable.
    `PTA(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, IDataTypeMap objIDataTypeMap)` Constructor for PTA class which takes five arguments and sets the value in the respective member variable.
    `PTA(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, int ITableNo, IDataTypeMap objIDataTypeMap)` Constructor for PTA class which takes six arguments and sets the value in the respective member variable.
    `PTA(int iMinLength, int iMaxLength, java.lang.String strCLength, int iComponentType)` Constructor for PTA class which takes four arguments and sets the value in the respective member variable.
    `PTA(int iMinLength, int iMaxLength, java.lang.String strCLength, int iTableNo, int iComponentType)` Constructor for PTA 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.
    `CWE` | `getAmountClass()` Returns Amount Class
    `MOP` | `getMoneyOrPercentage()` Returns Money or Percentage
    `CWE` | `getPolicyType()` Returns Policy Type
    `void` | `setAmountClass(CWE objCWE)` Sets the AmountClass.
    `void` | `setAmountClass(java.lang.String strAmountClass)` Sets the AmountClass.
    `void` | `setMoneyOrPercentage(MOP objMoneyOrPercentage)` Sets the MoneyOrPercentage.
    `void` | `setPolicyType(CWE objCWE)` Sets the PolicyType.
    `void` | `setPolicyType(java.lang.String strPolicyType)` Sets the PolicyType.
    `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

    - #### PTA

          public PTA()

      Default Constructor for PTA

    - #### PTA

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

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

    - #### PTA

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

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

    - #### PTA

          public PTA(int iComponentType,
             IDataTypeMap objIDataTypeMap)

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

    - #### PTA

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

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

    - #### PTA

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

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

    - #### setPolicyType

          public void setPolicyType(java.lang.String strPolicyType)

      Sets the PolicyType.
      Parameters:
        `strPolicyType` - Specifies the policy type.

    - #### setPolicyType

          public void setPolicyType(CWE objCWE)

      Sets the PolicyType.
      Parameters:
        `objCWE` - Specifies the policy type.

    - #### setAmountClass

          public void setAmountClass(java.lang.String strAmountClass)

      Sets the AmountClass.
      Parameters:
        `strAmountClass` - Specifies the amount quantity class.

    - #### setAmountClass

          public void setAmountClass(CWE objCWE)

      Sets the AmountClass.
      Parameters:
        `objCWE` - Specifies the amount quantity class.

    - #### setMoneyOrPercentage

          public void setMoneyOrPercentage(MOP objMoneyOrPercentage)

      Sets the MoneyOrPercentage.
      Parameters:
        `objMoneyOrPercentage` - specifies an amount that may be either currency or a percentage.

    - #### getPolicyType

          public CWE getPolicyType()

      Returns Policy Type
      Returns:
        CWE - data type.

    - #### getAmountClass

          public CWE getAmountClass()

      Returns Amount Class
      Returns:
        CWE - data type.

    - #### getMoneyOrPercentage

          public MOP getMoneyOrPercentage()

      Returns Money or Percentage
      Returns:
        MOP - data type.

    - #### validate

          public boolean validate()
                           throws InvalidDataTypeException

      The Method validates the Input value,and if validated properly then returns true. Here the validation 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.