cdac.medinfo.sdk.hl7282.baselibs

Class DIN

java.lang.Object

cdac.medinfo.sdk.hl7282.baselibs.CompositeDataType

cdac.medinfo.sdk.hl7282.baselibs.DIN

All Implemented Interfaces:

IDataType

public class DIN
extends CompositeDataType

DIN - Date and Institution Name

This data type specifies the date and institution information where a staff member became active or inactive.

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

1. Date (DTM)Required
2. Institution Name (CWE)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
DIN() Default Constructor for DIN
DIN(int iComponentType, IDataTypeMap objIDataTypeMap) Constructor for DIN class which takes two arguments and sets the value in the respective member variable.
DIN(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, IDataTypeMap objIDataTypeMap) Constructor for DIN class which takes five arguments and sets the value in the respective member variable.
DIN(int iComponentType, int iMinLength, int iMaxLength, java.lang.String strCLength, int ITableNo, IDataTypeMap objIDataTypeMap) Constructor for DIN class which takes six arguments and sets the value in the respective member variable.
DIN(int iMinLength, int iMaxLength, java.lang.String strCLength, int iComponentType) Constructor for DIN class which takes four arguments and sets the value in the respective member variable.
DIN(int iMinLength, int iMaxLength, java.lang.String strCLength, int iTableNo, int iComponentType) Constructor for DIN 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	getDate() Returns Date
CWE	getInstitutionName() Returns Institution Name
void	setDate(DTM objDTM) Sets the Date.
void	setDate(java.lang.String strDate) Sets the Date.
void	setInstitutionName(CWE objInstitutionName) Sets the Institution Name.
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

DIN

public DIN()

Default Constructor for DIN

DIN

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

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

DIN

public DIN(int iMinLength,
   int iMaxLength,
   java.lang.String strCLength,
   int iTableNo,
   int iComponentType)

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

DIN

public DIN(int iComponentType,
   IDataTypeMap objIDataTypeMap)

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

DIN

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

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

DIN

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

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

setDate

public void setDate(java.lang.String strDate)

Sets the Date.

Parameters:

strDate - specifies the Date.

setDate

public void setDate(DTM objDTM)

Sets the Date.

Parameters:

objDTM - specifies the Date.

setInstitutionName

public void setInstitutionName(CWE objInstitutionName)

Sets the Institution Name.

Parameters:

objInstitutionName - specifies the Institution Name.

getDate

public DTM getDate()

Returns Date

Returns:

DTM - data type.

getInstitutionName

public CWE getInstitutionName()

Returns Institution Name

Returns:

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