ca.uhn.hl7v2.model.v281.group

Class MFN_M16_MATERIAL_LOCATION

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.MFN_M16_MATERIAL_LOCATION

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class MFN_M16_MATERIAL_LOCATION
extends AbstractGroup

Represents a MFN_M16_MATERIAL_LOCATION group structure (a Group object). A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. This Group contains the following elements:

• 1: IVT (Material Location)
• 2: ILT (Material Lot) optional repeating
• 3: NTE (Notes and Comments) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
MFN_M16_MATERIAL_LOCATION(Group parent, ModelClassFactory factory) Creates a new MFN_M16_MATERIAL_LOCATION group

Method Summary

Modifier and Type	Method and Description
ILT	getILT() Returns the first repetition of ILT (Material Lot) - creates it if necessary
ILT	getILT(int rep) Returns a specific repetition of ILT (Material Lot) - creates it if necessary
List<ILT>	getILTAll() Returns a non-modifiable List containing all current existing repetitions of ILT.
int	getILTReps() Returns the number of existing repetitions of ILT
IVT	getIVT() Returns IVT (Material Location) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (Notes and Comments) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
String	getVersion() Returns "2.8.1"
void	insertILT(ILT structure, int rep) Inserts a specific repetition of ILT (Material Lot)
ILT	insertILT(int rep) Inserts a specific repetition of ILT (Material Lot)
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and Comments)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and Comments)
ILT	removeILT(int rep) Removes a specific repetition of ILT (Material Lot)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)

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

accept, add, add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insert, insertRepetition, insertRepetition, isChoiceElement, isEmpty, isGroup, isRepeating, isRequired, provideLocation, removeRepetition, tryToInstantiateStructure, visitNestedStructures

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

MFN_M16_MATERIAL_LOCATION

public MFN_M16_MATERIAL_LOCATION(Group parent,
                                 ModelClassFactory factory)

Creates a new MFN_M16_MATERIAL_LOCATION group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getIVT

public IVT getIVT()

Returns IVT (Material Location) - creates it if necessary

getILT

public ILT getILT()

Returns the first repetition of ILT (Material Lot) - creates it if necessary

getILT

public ILT getILT(int rep)

Returns a specific repetition of ILT (Material Lot) - creates it if necessary

Parameters:

rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)

Throws:

HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

getILTReps

public int getILTReps()

Returns the number of existing repetitions of ILT

getILTAll

public List<ILT> getILTAll()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of ILT.

Note that unlike getILT(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertILT

public void insertILT(ILT structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of ILT (Material Lot)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertILT

public ILT insertILT(int rep)
              throws HL7Exception

Inserts a specific repetition of ILT (Material Lot)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeILT

public ILT removeILT(int rep)
              throws HL7Exception

Removes a specific repetition of ILT (Material Lot)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and Comments) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and Comments) - creates it if necessary

Parameters:

rep - The repetition index (0-indexed, i.e. the first repetition is at index 0)

Throws:

HL7Exception - if the repetition requested is more than one greater than the number of existing repetitions.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

Returns a non-modifiable List containing all current existing repetitions of NTE.

Note that unlike getNTE(), this method will not create any reps if none are already present, so an empty list may be returned.

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and Comments)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)