com.merge.HL7.v231.fields
Class HL7FieldDLN

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v231.fields.HL7FieldDLN

public class HL7FieldDLN
extends HL7Field

This field contains the driver’s license information. For state or province refer to official postal codes for that country; for country refer to ISO 3166 for codes.

Nested Class Summary

Nested classes/interfaces inherited from class com.merge.HL7.HL7Field

HL7Field.FieldFormatter

Field Summary

Fields inherited from class com.merge.HL7.HL7Field

EMPTY_VALUE, NULL_VALUE

Constructor Summary

HL7FieldDLN()
Creates an empty HL7 DLN type field object.

Method Summary

java.lang.String	getComponentDescription(int index) Gets the description of a component in this field.
int	getComponentLength(int index) Gets the maximum number of characters for a component in this field.
java.lang.String	getComponentType(int index) Gets the HL7 data type of a component in this field.
java.lang.String	getExpirationDate() Gets the Expiration Date component of this field.
java.lang.String	getIssuingStateProvinceCountry() Gets the Issuing State, Province, Country component of this field.
java.lang.String	getLicenseNumber() Gets the License Number component of this field.
int	getMaxSize() Gets the number of components defined for this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isExpirationDateEmpty() Tells whether the Expiration Date component has been specified.
boolean	isExpirationDateNull() Tells whether the Expiration Date component has a has Null value as defined by HL7.
boolean	isIssuingStateProvinceCountryEmpty() Tells whether the Issuing State, Province, Country component has been specified.
boolean	isIssuingStateProvinceCountryNull() Tells whether the Issuing State, Province, Country component has a has Null value as defined by HL7.
boolean	isLicenseNumberEmpty() Tells whether the License Number component has been specified.
boolean	isLicenseNumberNull() Tells whether the License Number component has a has Null value as defined by HL7.
void	setExpirationDate(java.lang.String val) Sets the Expiration Date from a string.
void	setIssuingStateProvinceCountry(java.lang.String val) Sets the Issuing State, Province, Country from a string.
void	setLicenseNumber(java.lang.String val) Sets the License Number from a string.

Methods inherited from class com.merge.HL7.HL7Field

clone, createField, createField, getBoolValue, getComponent, getContent, getContent, getContent, getDataType, getDateValue, getDoubleValue, getFieldFormatter, getFieldName, getHL7Version, getIntValue, getMinSize, getValue, getValue, isBasicType, isEmpty, isNull, setComponent, setContent, setContent, setFieldClass, setFormatter, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, size, toAnnotatedString, toAnnotatedString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HL7FieldDLN

public HL7FieldDLN()

Creates an empty HL7 DLN type field object.

Method Detail

getMaxSize

public int getMaxSize()

Gets the number of components defined for this field.

Overrides:

getMaxSize in class HL7Field

Returns:

The maximum number of components.

getComponentType

public java.lang.String getComponentType(int index)

Gets the HL7 data type of a component in this field.

Overrides:

getComponentType in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's data type.

getComponentDescription

public java.lang.String getComponentDescription(int index)

Gets the description of a component in this field.

Overrides:

getComponentDescription in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the component's description.

getComponentLength

public int getComponentLength(int index)

Gets the maximum number of characters for a component in this field.

Overrides:

getComponentLength in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

The maximum length of the component as defined by HL7.

isComponentMandatory

public boolean isComponentMandatory(int index)

Tells whether a component is mandatory.

Overrides:

isComponentMandatory in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

true if the specified component is mandatory.

getTableNo

public java.lang.String getTableNo(int index)

Gets the table identifier of a component in this field.

Overrides:

getTableNo in class HL7Field

Parameters:

index - The one based index of the component.

Returns:

A string representing the table number as defined by HL7 or an empty string if a table number is not defined.

getLicenseNumber

public java.lang.String getLicenseNumber()

Gets the License Number component of this field.

Returns:

the License Number value

setLicenseNumber

public void setLicenseNumber(java.lang.String val)

Sets the License Number from a string.

Parameters:

val - The value to set for License Number

isLicenseNumberEmpty

public boolean isLicenseNumberEmpty()

Tells whether the License Number component has been specified.

Returns:

true if the component is empty.

isLicenseNumberNull

public boolean isLicenseNumberNull()

Tells whether the License Number component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getIssuingStateProvinceCountry

public java.lang.String getIssuingStateProvinceCountry()

Gets the Issuing State, Province, Country component of this field.

Returns:

the Issuing State, Province, Country value

setIssuingStateProvinceCountry

public void setIssuingStateProvinceCountry(java.lang.String val)

Sets the Issuing State, Province, Country from a string.

Parameters:

val - The value to set for Issuing State, Province, Country

isIssuingStateProvinceCountryEmpty

public boolean isIssuingStateProvinceCountryEmpty()

Tells whether the Issuing State, Province, Country component has been specified.

Returns:

true if the component is empty.

isIssuingStateProvinceCountryNull

public boolean isIssuingStateProvinceCountryNull()

Tells whether the Issuing State, Province, Country component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getExpirationDate

public java.lang.String getExpirationDate()

Gets the Expiration Date component of this field.

Returns:

the Expiration Date value

setExpirationDate

public void setExpirationDate(java.lang.String val)

Sets the Expiration Date from a string.

Parameters:

val - The value to set for Expiration Date

isExpirationDateEmpty

public boolean isExpirationDateEmpty()

Tells whether the Expiration Date component has been specified.

Returns:

true if the component is empty.

isExpirationDateNull

public boolean isExpirationDateNull()

Tells whether the Expiration Date component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.