com.merge.HL7.v251.fields
Class HL7FieldDIN

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v251.fields.HL7FieldDIN

public class HL7FieldDIN
extends HL7Field

Specifies the date and institution information where a staff member became active or inactive.

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

HL7FieldDIN()
Creates an empty HL7 DIN 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.
HL7FieldTS	getDate() Gets the Date component of this field.
java.lang.String	getDateFieldValue() Gets the Date component of this field.
HL7FieldCE	getInstitutionName() Gets the Institution Name component of this field.
java.lang.String	getInstitutionNameValue() Gets the Institution Name 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	isDateEmpty() Tells whether the Date component has been specified.
boolean	isDateNull() Tells whether the Date component has a has Null value as defined by HL7.
boolean	isInstitutionNameEmpty() Tells whether the Institution Name component has been specified.
boolean	isInstitutionNameNull() Tells whether the Institution Name component has a has Null value as defined by HL7.
void	setDate(HL7FieldTS val) Sets the Date component of this field.
void	setDateFieldValue(java.lang.String val) Sets the Date from a string.
void	setInstitutionName(HL7FieldCE val) Sets the Institution Name component of this field.
void	setInstitutionNameValue(java.lang.String val) Sets the Institution Name 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

HL7FieldDIN

public HL7FieldDIN()

Creates an empty HL7 DIN 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.

getDateFieldValue

public java.lang.String getDateFieldValue()

Gets the Date component of this field.

Returns:

the Date value

setDateFieldValue

public void setDateFieldValue(java.lang.String val)

Sets the Date from a string.

Parameters:

val - The value to set for Date

getDate

public HL7FieldTS getDate()

Gets the Date component of this field.

Returns:

An HL7FieldTS object representing Date

setDate

public void setDate(HL7FieldTS val)

Sets the Date component of this field.

Parameters:

val - An HL7FieldTS object containing the value to be set.

isDateEmpty

public boolean isDateEmpty()

Tells whether the Date component has been specified.

Returns:

true if the component is empty.

isDateNull

public boolean isDateNull()

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

Returns:

true if the component has the HL7 Null value.

getInstitutionNameValue

public java.lang.String getInstitutionNameValue()

Gets the Institution Name component of this field.

Returns:

the Institution Name value

setInstitutionNameValue

public void setInstitutionNameValue(java.lang.String val)

Sets the Institution Name from a string.

Parameters:

val - The value to set for Institution Name

getInstitutionName

public HL7FieldCE getInstitutionName()

Gets the Institution Name component of this field.

Returns:

An HL7FieldCE object representing Institution Name

setInstitutionName

public void setInstitutionName(HL7FieldCE val)

Sets the Institution Name component of this field.

Parameters:

val - An HL7FieldCE object containing the value to be set.

isInstitutionNameEmpty

public boolean isInstitutionNameEmpty()

Tells whether the Institution Name component has been specified.

Returns:

true if the component is empty.

isInstitutionNameNull

public boolean isInstitutionNameNull()

Tells whether the Institution Name component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.