cdac.medinfo.sdk.hl7282.baselibs

## Class RI

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

- All Implemented Interfaces:
    IDataType

      public class RI
      extends CompositeDataType

  RI - Repeat interval

  This data type contains the interval between repeated services.

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

  1. Repeat Pattern (CWE)Optional
  2. Explicit Time Interval (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
    `RI()` Default Constructor for RI
    `RI(int iComponentType, IDataTypeMap objIDataTypeMap)` Constructor for RI class which takes two arguments and sets the value in the respective member variable.
    `RI(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, IDataTypeMap objIDataTypeMap)` Constructor for RI class which takes five arguments and sets the value in the respective member variable.
    `RI(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, int ITableNo, IDataTypeMap objIDataTypeMap)` Constructor for RI class which takes six arguments and sets the value in the respective member variable.
    `RI(int iMinLength, int iMaxLength, java.lang.String strCLength, int iComponentType)` Constructor for RI class which takes four arguments and sets the value in the respective member variable.
    `RI(int iMinLength, int iMaxLength, java.lang.String strCLength, int iTableNo, int iComponentType)` Constructor for RI 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` | `getExplicitTimeInterval()` Returns Explicit Time Interval
    `IS` | `getRepeatPattern()` Returns Repeat Pattern
    `void` | `setExplicitTimeInterval(ST objST)` Sets the ExplicitTimeInterval.
    `void` | `setExplicitTimeInterval(java.lang.String strExplicitTimeInterval)` Sets the ExplicitTimeInterval.
    `void` | `setRepeatPattern(CWE objCWE)` Sets the RepeatPattern.
    `void` | `setRepeatPattern(java.lang.String strRepeatPattern)` Sets the RepeatPattern.

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

    - #### RI

          public RI()

      Default Constructor for RI

    - #### RI

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

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

    - #### RI

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

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

    - #### RI

          public RI(int iComponentType,
            IDataTypeMap objIDataTypeMap)

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

    - #### RI

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

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

    - #### RI

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

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

    - #### setRepeatPattern

          public void setRepeatPattern(java.lang.String strRepeatPattern)

      Sets the RepeatPattern.
      Parameters:
        `strRepeatPattern` - The repeating frequency with which the treatment is to be administered.

    - #### setRepeatPattern

          public void setRepeatPattern(CWE objCWE)

      Sets the RepeatPattern.
      Parameters:
        `objCWE` - The repeating frequency with which the treatment is to be administered.

    - #### setExplicitTimeInterval

          public void setExplicitTimeInterval(java.lang.String strExplicitTimeInterval)

      Sets the ExplicitTimeInterval.
      Parameters:
        `strExplicitTimeInterval` - This component explicitly lists the actual times referenced by the code in the first component

    - #### setExplicitTimeInterval

          public void setExplicitTimeInterval(ST objST)

      Sets the ExplicitTimeInterval.
      Parameters:
        `objST` - This component explicitly lists the actual times referenced by the code in the first component

    - #### getRepeatPattern

          public IS getRepeatPattern()

      Returns Repeat Pattern
      Returns:
        IS - data type.

    - #### getExplicitTimeInterval

          public ST getExplicitTimeInterval()

      Returns Explicit Time Interval
      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.