cdac.medinfo.sdk.hl7282.baselibs

## Class DTN

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

- All Implemented Interfaces:
    IDataType

      public class DTN
      extends CompositeDataType

  DTN - Day Type and Number

  This data type specifies the type and number of days for which a certification is valid.

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

  1. Day Type (CWE)Required
  2. Number of Days (NM)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
    `DTN()` Default Constructor for DTN
    `DTN(int iComponentType, IDataTypeMap objIDataTypeMap)` Constructor for DTN class which takes two arguments and sets the value in the respective member variable.
    `DTN(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, IDataTypeMap objIDataTypeMap)` Constructor for DTN class which takes five arguments and sets the value in the respective member variable.
    `DTN(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, int ITableNo, IDataTypeMap objIDataTypeMap)` Constructor for DTN class which takes six arguments and sets the value in the respective member variable.
    `DTN(int iMinLength, int iMaxLength, java.lang.String strCLength, int iComponentType)` Constructor for DTN class which takes four arguments and sets the value in the respective member variable.
    `DTN(int iMinLength, int iMaxLength, java.lang.String strCLength, int iTableNo, int iComponentType)` Constructor for DTN 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` | `getDayType()` Returns Day Type
    `NM` | `getNumberOfDays()` Returns Number of Days
    `void` | `setDayType(CWE objCWE)` Sets the DayType.
    `void` | `setDayType(java.lang.String strDayType)` Sets the DayType.
    `void` | `setNumberOfDays(NM objNM)` Sets the NumberOfDays.
    `void` | `setNumberOfDays(java.lang.String strNumberOfDays)` Sets the NumberOfDays.
    `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

    - #### DTN

          public DTN()

      Default Constructor for DTN

    - #### DTN

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

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

    - #### DTN

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

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

    - #### DTN

          public DTN(int iComponentType,
             IDataTypeMap objIDataTypeMap)

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

    - #### DTN

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

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

    - #### DTN

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

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

    - #### setDayType

          public void setDayType(java.lang.String strDayType)

      Sets the DayType.
      Parameters:
        `strDayType` - Specifies whether the days are denied, pending, or approved.[Refer to User-defined Table 0149] Suggested Values AP,DE,PE

    - #### setDayType

          public void setDayType(CWE objCWE)

      Sets the DayType.
      Parameters:
        `objDayCWE` - Specifies whether the days are denied, pending, or approved.[Refer to User-defined Table 0149] Suggested Values AP,DE,PE

    - #### setNumberOfDays

          public void setNumberOfDays(java.lang.String strNumberOfDays)

      Sets the NumberOfDays.
      Parameters:
        `strNumberOfDays` - Specifies the number of days for which the certification is valid.

    - #### setNumberOfDays

          public void setNumberOfDays(NM objNM)

      Sets the NumberOfDays.
      Parameters:
        `objNM` - Specifies the number of days for which the certification is valid.

    - #### getDayType

          public CWE getDayType()

      Returns Day Type
      Returns:
        CWE - data type.

    - #### getNumberOfDays

          public NM getNumberOfDays()

      Returns Number of Days
      Returns:
        NM - 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.