com.merge.HL7.v251.fields
Class HL7FieldAUI

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

public class HL7FieldAUI
extends HL7Field

This data type specifies the identifier or code for an insurance authorization instance and its associated detail.

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

HL7FieldAUI()
Creates an empty HL7 AUI type field object.

Method Summary

java.lang.String	getAuthorizationNumber() Gets the Authorization Number 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	getDate() Gets the Date component of this field.
int	getMaxSize() Gets the number of components defined for this field.
java.lang.String	getSource() Gets the Source component of this field.
java.lang.String	getTableNo(int index) Gets the table identifier of a component in this field.
boolean	isAuthorizationNumberEmpty() Tells whether the Authorization Number component has been specified.
boolean	isAuthorizationNumberNull() Tells whether the Authorization Number component has a has Null value as defined by HL7.
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	isSourceEmpty() Tells whether the Source component has been specified.
boolean	isSourceNull() Tells whether the Source component has a has Null value as defined by HL7.
void	setAuthorizationNumber(java.lang.String val) Sets the Authorization Number from a string.
void	setDate(java.lang.String val) Sets the Date from a string.
void	setSource(java.lang.String val) Sets the Source 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

HL7FieldAUI

public HL7FieldAUI()

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

getAuthorizationNumber

public java.lang.String getAuthorizationNumber()

Gets the Authorization Number component of this field.

Returns:

the Authorization Number value

setAuthorizationNumber

public void setAuthorizationNumber(java.lang.String val)

Sets the Authorization Number from a string.

Parameters:

val - The value to set for Authorization Number

isAuthorizationNumberEmpty

public boolean isAuthorizationNumberEmpty()

Tells whether the Authorization Number component has been specified.

Returns:

true if the component is empty.

isAuthorizationNumberNull

public boolean isAuthorizationNumberNull()

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

Returns:

true if the component has the HL7 Null value.

getDate

public java.lang.String getDate()

Gets the Date component of this field.

Returns:

the Date value

setDate

public void setDate(java.lang.String val)

Sets the Date from a string.

Parameters:

val - The value to set for Date

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.

getSource

public java.lang.String getSource()

Gets the Source component of this field.

Returns:

the Source value

setSource

public void setSource(java.lang.String val)

Sets the Source from a string.

Parameters:

val - The value to set for Source

isSourceEmpty

public boolean isSourceEmpty()

Tells whether the Source component has been specified.

Returns:

true if the component is empty.

isSourceNull

public boolean isSourceNull()

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

Returns:

true if the component has the HL7 Null value.