com.merge.HL7.v260.fields
Class HL7FieldERL

java.lang.Object
  com.merge.HL7.HL7Field
      com.merge.HL7.v260.fields.HL7FieldERL

public class HL7FieldERL
extends HL7Field

This data type identifies the segment and its constituent where an error has occurred.

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

HL7FieldERL()
Creates an empty HL7 ERL 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	getComponentNumber() Gets the Component Number component of this field.
java.lang.String	getComponentType(int index) Gets the HL7 data type of a component in this field.
java.lang.String	getFieldPosition() Gets the Field Position component of this field.
java.lang.String	getFieldRepetition() Gets the Field Repetition component of this field.
int	getMaxSize() Gets the number of components defined for this field.
java.lang.String	getSegmentID() Gets the Segment ID component of this field.
java.lang.String	getSegmentSequence() Gets the Segment Sequence component of this field.
java.lang.String	getSubComponentNumber() Gets the Sub-Component Number component of 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	isComponentNumberEmpty() Tells whether the Component Number component has been specified.
boolean	isComponentNumberNull() Tells whether the Component Number component has a has Null value as defined by HL7.
boolean	isFieldPositionEmpty() Tells whether the Field Position component has been specified.
boolean	isFieldPositionNull() Tells whether the Field Position component has a has Null value as defined by HL7.
boolean	isFieldRepetitionEmpty() Tells whether the Field Repetition component has been specified.
boolean	isFieldRepetitionNull() Tells whether the Field Repetition component has a has Null value as defined by HL7.
boolean	isSegmentIDEmpty() Tells whether the Segment ID component has been specified.
boolean	isSegmentIDNull() Tells whether the Segment ID component has a has Null value as defined by HL7.
boolean	isSegmentSequenceEmpty() Tells whether the Segment Sequence component has been specified.
boolean	isSegmentSequenceNull() Tells whether the Segment Sequence component has a has Null value as defined by HL7.
boolean	isSubComponentNumberEmpty() Tells whether the Sub-Component Number component has been specified.
boolean	isSubComponentNumberNull() Tells whether the Sub-Component Number component has a has Null value as defined by HL7.
void	setComponentNumber(java.lang.String val) Sets the Component Number from a string.
void	setFieldPosition(java.lang.String val) Sets the Field Position from a string.
void	setFieldRepetition(java.lang.String val) Sets the Field Repetition from a string.
void	setSegmentID(java.lang.String val) Sets the Segment ID from a string.
void	setSegmentSequence(java.lang.String val) Sets the Segment Sequence from a string.
void	setSubComponentNumber(java.lang.String val) Sets the Sub-Component 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

HL7FieldERL

public HL7FieldERL()

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

getSegmentID

public java.lang.String getSegmentID()

Gets the Segment ID component of this field.

Returns:

the Segment ID value

setSegmentID

public void setSegmentID(java.lang.String val)

Sets the Segment ID from a string.

Parameters:

val - The value to set for Segment ID

isSegmentIDEmpty

public boolean isSegmentIDEmpty()

Tells whether the Segment ID component has been specified.

Returns:

true if the component is empty.

isSegmentIDNull

public boolean isSegmentIDNull()

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

Returns:

true if the component has the HL7 Null value.

getSegmentSequence

public java.lang.String getSegmentSequence()

Gets the Segment Sequence component of this field.

Returns:

the Segment Sequence value

setSegmentSequence

public void setSegmentSequence(java.lang.String val)

Sets the Segment Sequence from a string.

Parameters:

val - The value to set for Segment Sequence

isSegmentSequenceEmpty

public boolean isSegmentSequenceEmpty()

Tells whether the Segment Sequence component has been specified.

Returns:

true if the component is empty.

isSegmentSequenceNull

public boolean isSegmentSequenceNull()

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

Returns:

true if the component has the HL7 Null value.

getFieldPosition

public java.lang.String getFieldPosition()

Gets the Field Position component of this field.

Returns:

the Field Position value

setFieldPosition

public void setFieldPosition(java.lang.String val)

Sets the Field Position from a string.

Parameters:

val - The value to set for Field Position

isFieldPositionEmpty

public boolean isFieldPositionEmpty()

Tells whether the Field Position component has been specified.

Returns:

true if the component is empty.

isFieldPositionNull

public boolean isFieldPositionNull()

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

Returns:

true if the component has the HL7 Null value.

getFieldRepetition

public java.lang.String getFieldRepetition()

Gets the Field Repetition component of this field.

Returns:

the Field Repetition value

setFieldRepetition

public void setFieldRepetition(java.lang.String val)

Sets the Field Repetition from a string.

Parameters:

val - The value to set for Field Repetition

isFieldRepetitionEmpty

public boolean isFieldRepetitionEmpty()

Tells whether the Field Repetition component has been specified.

Returns:

true if the component is empty.

isFieldRepetitionNull

public boolean isFieldRepetitionNull()

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

Returns:

true if the component has the HL7 Null value.

getComponentNumber

public java.lang.String getComponentNumber()

Gets the Component Number component of this field.

Returns:

the Component Number value

setComponentNumber

public void setComponentNumber(java.lang.String val)

Sets the Component Number from a string.

Parameters:

val - The value to set for Component Number

isComponentNumberEmpty

public boolean isComponentNumberEmpty()

Tells whether the Component Number component has been specified.

Returns:

true if the component is empty.

isComponentNumberNull

public boolean isComponentNumberNull()

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

Returns:

true if the component has the HL7 Null value.

getSubComponentNumber

public java.lang.String getSubComponentNumber()

Gets the Sub-Component Number component of this field.

Returns:

the Sub-Component Number value

setSubComponentNumber

public void setSubComponentNumber(java.lang.String val)

Sets the Sub-Component Number from a string.

Parameters:

val - The value to set for Sub-Component Number

isSubComponentNumberEmpty

public boolean isSubComponentNumberEmpty()

Tells whether the Sub-Component Number component has been specified.

Returns:

true if the component is empty.

isSubComponentNumberNull

public boolean isSubComponentNumberNull()

Tells whether the Sub-Component Number component has a has Null value as defined by HL7.

Returns:

true if the component has the HL7 Null value.