cdac.medinfo.sdk.hl7282.baselibs

## Class DR

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

- All Implemented Interfaces:
    IDataType

      public class DR
      extends CompositeDataType

  DR - Date/Time range

  This data type specifies the date/time range. DR can be legally expressed when embedded within another data type. Its use is constrained to a segment field. DR can be embedded as a COMPONENT or SUBCOMPONENT. If DR expressed as a SUBCOMPONENT then TS DataType expressed as SUBSUBCOMPONENT.

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

  1. Range Start Date/Time (DTM)Optional
  2. Range End Date/Time (DTM)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
    `DR()` Default Constructor for DR
    `DR(int iComponentType, IDataTypeMap objIDataTypeMap)` Constructor for DR class which takes two arguments and sets the value in the respective member variable.
    `DR(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, IDataTypeMap objIDataTypeMap)` Constructor for DR class which takes five arguments and sets the value in the respective member variable.
    `DR(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, int ITableNo, IDataTypeMap objIDataTypeMap)` Constructor for DR class which takes six arguments and sets the value in the respective member variable.
    `DR(int iMinLength, int iMaxLength, java.lang.String strCLength, int iComponentType)` Constructor for DR class which takes four arguments and sets the value in the respective member variable.
    `DR(int iMinLength, int iMaxLength, java.lang.String strCLength, int iTableNo, int iComponentType)` Constructor for DR 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.
    `DTM` | `getRangeEndDateTime()` Returns Range End Date/Time
    `DTM` | `getRangeStartDateTime()` Returns Range Start Date/Time
    `void` | `setRangeEndDateTime(DTM objRangeEndDateTime)` Sets the RangeEndDateTime.
    `void` | `setRangeStartDateTime(DTM objRangeStartDateTime)` Sets the Range Start DateTime.

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

    - #### DR

          public DR()

      Default Constructor for DR

    - #### DR

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

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

    - #### DR

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

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

    - #### DR

          public DR(int iComponentType,
            IDataTypeMap objIDataTypeMap)

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

    - #### DR

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

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

    - #### DR

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

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

    - #### setRangeStartDateTime

          public void setRangeStartDateTime(DTM objRangeStartDateTime)

      Sets the Range Start DateTime.
      Parameters:
        `objRangeStartDateTime` - Specifies the earliest date/time (time stamp) in the specified range.

    - #### setRangeEndDateTime

          public void setRangeEndDateTime(DTM objRangeEndDateTime)

      Sets the RangeEndDateTime.
      Parameters:
        `objRangeEndDateTime` - Specifies the latest date/time in the specified range.

    - #### getRangeStartDateTime

          public DTM getRangeStartDateTime()

      Returns Range Start Date/Time
      Returns:
        DTM - data type.

    - #### getRangeEndDateTime

          public DTM getRangeEndDateTime()

      Returns Range End Date/Time
      Returns:
        TS - 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.