ca.uhn.hl7v2.model.v24.segment

Class LAN

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v24.segment.LAN

All Implemented Interfaces:

Segment, Structure, Visitable, Serializable

public class LAN
extends AbstractSegment

Represents an HL7 LAN message segment (Language Detail). This segment has the following fields:

• LAN-1: Set ID - LAN (SI)
• LAN-2: Language Code (CE)
• LAN-3: Language Ability Code (CE) optional repeating
• LAN-4: Language Proficiency Code (CE) optional

See Also:

Serialized Form

Field Summary

Fields inherited from class ca.uhn.hl7v2.model.AbstractStructure

log

Constructor Summary

Constructors

Constructor and Description
LAN(Group parent, ModelClassFactory factory) Creates a new LAN segment

Method Summary

Modifier and Type	Method and Description
protected Type	createNewTypeWithoutReflection(int field)
SI	getLan1_SetIDLAN() Returns LAN-1: "Set ID - LAN" - creates it if necessary
CE	getLan2_LanguageCode() Returns LAN-2: "Language Code" - creates it if necessary
CE[]	getLan3_LanguageAbilityCode() Returns all repetitions of Language Ability Code (LAN-3).
CE	getLan3_LanguageAbilityCode(int rep) Returns a specific repetition of LAN-3: "Language Ability Code" - creates it if necessary
int	getLan3_LanguageAbilityCodeReps() Returns a count of the current number of repetitions of Language Ability Code (LAN-3).
CE	getLan4_LanguageProficiencyCode() Returns LAN-4: "Language Proficiency Code" - creates it if necessary
CE[]	getLanguageAbilityCode() Returns all repetitions of Language Ability Code (LAN-3).
CE	getLanguageAbilityCode(int rep) Returns a specific repetition of LAN-3: "Language Ability Code" - creates it if necessary
int	getLanguageAbilityCodeReps() Returns a count of the current number of repetitions of Language Ability Code (LAN-3).
CE	getLanguageCode() Returns LAN-2: "Language Code" - creates it if necessary
CE	getLanguageProficiencyCode() Returns LAN-4: "Language Proficiency Code" - creates it if necessary
SI	getSetIDLAN() Returns LAN-1: "Set ID - LAN" - creates it if necessary
CE	insertLan3_LanguageAbilityCode(int rep) Inserts a repetition of LAN-3: "Language Ability Code" at a specific index
CE	insertLanguageAbilityCode(int rep) Inserts a repetition of LAN-3: "Language Ability Code" at a specific index
CE	removeLan3_LanguageAbilityCode(int rep) Removes a repetition of LAN-3: "Language Ability Code" at a specific index
CE	removeLanguageAbilityCode(int rep) Removes a repetition of LAN-3: "Language Ability Code" at a specific index

Methods inherited from class ca.uhn.hl7v2.model.AbstractSegment

accept, add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isEmpty, isRequired, main, numFields, parse, provideLocation, removeRepetition

Methods inherited from class ca.uhn.hl7v2.model.AbstractStructure

getMessage, getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getMessage, getParent

Constructor Detail

LAN

public LAN(Group parent,
           ModelClassFactory factory)

Creates a new LAN segment

Method Detail

getSetIDLAN

public SI getSetIDLAN()

Returns LAN-1: "Set ID - LAN" - creates it if necessary

getLan1_SetIDLAN

public SI getLan1_SetIDLAN()

Returns LAN-1: "Set ID - LAN" - creates it if necessary

getLanguageCode

public CE getLanguageCode()

Returns LAN-2: "Language Code" - creates it if necessary

getLan2_LanguageCode

public CE getLan2_LanguageCode()

Returns LAN-2: "Language Code" - creates it if necessary

getLanguageAbilityCode

public CE[] getLanguageAbilityCode()

Returns all repetitions of Language Ability Code (LAN-3).

getLan3_LanguageAbilityCode

public CE[] getLan3_LanguageAbilityCode()

Returns all repetitions of Language Ability Code (LAN-3).

getLanguageAbilityCodeReps

public int getLanguageAbilityCodeReps()

Returns a count of the current number of repetitions of Language Ability Code (LAN-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getLanguageAbilityCode

public CE getLanguageAbilityCode(int rep)

Returns a specific repetition of LAN-3: "Language Ability Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getLan3_LanguageAbilityCode

public CE getLan3_LanguageAbilityCode(int rep)

Returns a specific repetition of LAN-3: "Language Ability Code" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getLan3_LanguageAbilityCodeReps

public int getLan3_LanguageAbilityCodeReps()

Returns a count of the current number of repetitions of Language Ability Code (LAN-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertLanguageAbilityCode

public CE insertLanguageAbilityCode(int rep)
                             throws HL7Exception

Inserts a repetition of LAN-3: "Language Ability Code" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertLan3_LanguageAbilityCode

public CE insertLan3_LanguageAbilityCode(int rep)
                                  throws HL7Exception

Inserts a repetition of LAN-3: "Language Ability Code" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeLanguageAbilityCode

public CE removeLanguageAbilityCode(int rep)
                             throws HL7Exception

Removes a repetition of LAN-3: "Language Ability Code" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeLan3_LanguageAbilityCode

public CE removeLan3_LanguageAbilityCode(int rep)
                                  throws HL7Exception

Removes a repetition of LAN-3: "Language Ability Code" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

getLanguageProficiencyCode

public CE getLanguageProficiencyCode()

Returns LAN-4: "Language Proficiency Code" - creates it if necessary

getLan4_LanguageProficiencyCode

public CE getLan4_LanguageProficiencyCode()

Returns LAN-4: "Language Proficiency Code" - creates it if necessary

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment