com.merge.HL7.v240.fields
Class HL7FieldCK

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

public class HL7FieldCK
extends HL7Field

Composite ID with check digit

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

HL7FieldCK()
Creates an empty HL7 CK type field object.

Method Summary

HL7FieldHD	getAssigningAuthority() Gets the AssigningAuthority component of this field.
java.lang.String	getAssigningAuthorityValue() Gets the AssigningAuthority component of this field.
java.lang.String	getCheckDigit() Gets the CheckDigit component of this field.
java.lang.String	getCodeIdentifyingTheCheckDigitSchemeEmployed() Gets the Code Identifying the Check Digit Scheme Employed component of this field.
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	getIDNumber() Gets the IDNumber 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	isAssigningAuthorityEmpty() Tells whether the AssigningAuthority component has been specified.
boolean	isAssigningAuthorityNull() Tells whether the AssigningAuthority component has a has Null value as defined by HL7.
boolean	isCheckDigitEmpty() Tells whether the CheckDigit component has been specified.
boolean	isCheckDigitNull() Tells whether the CheckDigit component has a has Null value as defined by HL7.
boolean	isCodeIdentifyingTheCheckDigitSchemeEmployedEmpty() Tells whether the Code Identifying the Check Digit Scheme Employed component has been specified.
boolean	isCodeIdentifyingTheCheckDigitSchemeEmployedNull() Tells whether the Code Identifying the Check Digit Scheme Employed component has a has Null value as defined by HL7.
boolean	isComponentMandatory(int index) Tells whether a component is mandatory.
boolean	isIDNumberEmpty() Tells whether the IDNumber component has been specified.
boolean	isIDNumberNull() Tells whether the IDNumber component has a has Null value as defined by HL7.
void	setAssigningAuthority(HL7FieldHD val) Sets the AssigningAuthority component of this field.
void	setAssigningAuthorityValue(java.lang.String val) Sets the AssigningAuthority from a string.
void	setCheckDigit(java.lang.String val) Sets the CheckDigit from a string.
void	setCodeIdentifyingTheCheckDigitSchemeEmployed(java.lang.String val) Sets the Code Identifying the Check Digit Scheme Employed from a string.
void	setIDNumber(java.lang.String val) Sets the IDNumber 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

HL7FieldCK

public HL7FieldCK()

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

getIDNumber

public java.lang.String getIDNumber()

Gets the IDNumber component of this field.

Returns:

the IDNumber value

setIDNumber

public void setIDNumber(java.lang.String val)

Sets the IDNumber from a string.

Parameters:

val - The value to set for IDNumber

isIDNumberEmpty

public boolean isIDNumberEmpty()

Tells whether the IDNumber component has been specified.

Returns:

true if the component is empty.

isIDNumberNull

public boolean isIDNumberNull()

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

Returns:

true if the component has the HL7 Null value.

getCheckDigit

public java.lang.String getCheckDigit()

Gets the CheckDigit component of this field.

Returns:

the CheckDigit value

setCheckDigit

public void setCheckDigit(java.lang.String val)

Sets the CheckDigit from a string.

Parameters:

val - The value to set for CheckDigit

isCheckDigitEmpty

public boolean isCheckDigitEmpty()

Tells whether the CheckDigit component has been specified.

Returns:

true if the component is empty.

isCheckDigitNull

public boolean isCheckDigitNull()

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

Returns:

true if the component has the HL7 Null value.

getCodeIdentifyingTheCheckDigitSchemeEmployed

public java.lang.String getCodeIdentifyingTheCheckDigitSchemeEmployed()

Gets the Code Identifying the Check Digit Scheme Employed component of this field.

Returns:

the Code Identifying the Check Digit Scheme Employed value

setCodeIdentifyingTheCheckDigitSchemeEmployed

public void setCodeIdentifyingTheCheckDigitSchemeEmployed(java.lang.String val)

Sets the Code Identifying the Check Digit Scheme Employed from a string.

Parameters:

val - The value to set for Code Identifying the Check Digit Scheme Employed

isCodeIdentifyingTheCheckDigitSchemeEmployedEmpty

public boolean isCodeIdentifyingTheCheckDigitSchemeEmployedEmpty()

Tells whether the Code Identifying the Check Digit Scheme Employed component has been specified.

Returns:

true if the component is empty.

isCodeIdentifyingTheCheckDigitSchemeEmployedNull

public boolean isCodeIdentifyingTheCheckDigitSchemeEmployedNull()

Tells whether the Code Identifying the Check Digit Scheme Employed component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.

getAssigningAuthorityValue

public java.lang.String getAssigningAuthorityValue()

Gets the AssigningAuthority component of this field.

Returns:

the AssigningAuthority value

setAssigningAuthorityValue

public void setAssigningAuthorityValue(java.lang.String val)

Sets the AssigningAuthority from a string.

Parameters:

val - The value to set for AssigningAuthority

getAssigningAuthority

public HL7FieldHD getAssigningAuthority()

Gets the AssigningAuthority component of this field.

Returns:

An HL7FieldHD object representing AssigningAuthority

setAssigningAuthority

public void setAssigningAuthority(HL7FieldHD val)

Sets the AssigningAuthority component of this field.

Parameters:

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

isAssigningAuthorityEmpty

public boolean isAssigningAuthorityEmpty()

Tells whether the AssigningAuthority component has been specified.

Returns:

true if the component is empty.

isAssigningAuthorityNull

public boolean isAssigningAuthorityNull()

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

Returns:

true if the component has the HL7 Null value.