com.merge.HL7.v240.fields
Class HL7FieldFC

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v240.fields.HL7FieldFC

public class HL7FieldFC
extends HL7Field

This component contains the financial class assigned to a person. User-defined Table 0064 - Financial class is used as the HL7 identifier for the user-defined table of values for this component.

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

HL7FieldFC()
Creates an empty HL7 FC 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	getEffectiveDate() Gets the Effective Date component of this field.
java.lang.String	getEffectiveDateValue() Gets the Effective Date component of this field.
java.lang.String	getFinancialClassCode() Gets the Financial Class Code 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	isEffectiveDateEmpty() Tells whether the Effective Date component has been specified.
boolean	isEffectiveDateNull() Tells whether the Effective Date component has a has Null value as defined by HL7.
boolean	isFinancialClassCodeEmpty() Tells whether the Financial Class Code component has been specified.
boolean	isFinancialClassCodeNull() Tells whether the Financial Class Code component has a has Null value as defined by HL7.
void	setEffectiveDate(HL7FieldTS val) Sets the Effective Date component of this field.
void	setEffectiveDateValue(java.lang.String val) Sets the Effective Date from a string.
void	setFinancialClassCode(java.lang.String val) Sets the Financial Class Code 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

HL7FieldFC

public HL7FieldFC()

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

getFinancialClassCode

public java.lang.String getFinancialClassCode()

Gets the Financial Class Code component of this field.

Returns:

the Financial Class Code value

setFinancialClassCode

public void setFinancialClassCode(java.lang.String val)

Sets the Financial Class Code from a string.

Parameters:

val - The value to set for Financial Class Code

isFinancialClassCodeEmpty

public boolean isFinancialClassCodeEmpty()

Tells whether the Financial Class Code component has been specified.

Returns:

true if the component is empty.

isFinancialClassCodeNull

public boolean isFinancialClassCodeNull()

Tells whether the Financial Class Code component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getEffectiveDateValue

public java.lang.String getEffectiveDateValue()

Gets the Effective Date component of this field.

Returns:

the Effective Date value

setEffectiveDateValue

public void setEffectiveDateValue(java.lang.String val)

Sets the Effective Date from a string.

Parameters:

val - The value to set for Effective Date

getEffectiveDate

public HL7FieldTS getEffectiveDate()

Gets the Effective Date component of this field.

Returns:

An HL7FieldTS object representing Effective Date

setEffectiveDate

public void setEffectiveDate(HL7FieldTS val)

Sets the Effective Date component of this field.

Parameters:

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

isEffectiveDateEmpty

public boolean isEffectiveDateEmpty()

Tells whether the Effective Date component has been specified.

Returns:

true if the component is empty.

isEffectiveDateNull

public boolean isEffectiveDateNull()

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

Returns:

true if the component has the HL7 Null value.