ca.uhn.hl7v2.model.v26.group

Class EHC_E20_PSL_ITEM_INFO

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v26.group.EHC_E20_PSL_ITEM_INFO

All Implemented Interfaces:

Group, Structure, Serializable

public class EHC_E20_PSL_ITEM_INFO
extends AbstractGroup

Represents a EHC_E20_PSL_ITEM_INFO 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: PSL (Product/Service Line Item) choice
• 2: NTE (Notes and Comments) optional repeating choice
• 3: ADJ (Adjustment) optional repeating choice
• 4: LOC (Location Identification) optional repeating choice
• 5: ROL (Role) optional repeating choice

Note that this structure has "choice" elements. This means that one of the structures above marked as "choice" must be present, but no more than one.

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ADJ	getADJ() Returns the first repetition of ADJ (Adjustment) - creates it if necessary
ADJ	getADJ(int rep) Returns a specific repetition of ADJ (Adjustment) - creates it if necessary
List<ADJ>	getADJAll() Returns a non-modifiable List containing all current existing repetitions of ADJ.
int	getADJReps() Returns the number of existing repetitions of ADJ
LOC	getLOC() Returns the first repetition of LOC (Location Identification) - creates it if necessary
LOC	getLOC(int rep) Returns a specific repetition of LOC (Location Identification) - creates it if necessary
List<LOC>	getLOCAll() Returns a non-modifiable List containing all current existing repetitions of LOC.
int	getLOCReps() Returns the number of existing repetitions of LOC
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
PSL	getPSL() Returns PSL (Product/Service Line Item) - creates it if necessary
ROL	getROL() Returns the first repetition of ROL (Role) - creates it if necessary
ROL	getROL(int rep) Returns a specific repetition of ROL (Role) - creates it if necessary
List<ROL>	getROLAll() Returns a non-modifiable List containing all current existing repetitions of ROL.
int	getROLReps() Returns the number of existing repetitions of ROL
String	getVersion() Returns "2.6"
void	insertADJ(ADJ structure, int rep) Inserts a specific repetition of ADJ (Adjustment)
ADJ	insertADJ(int rep) Inserts a specific repetition of ADJ (Adjustment)
LOC	insertLOC(int rep) Inserts a specific repetition of LOC (Location Identification)
void	insertLOC(LOC structure, int rep) Inserts a specific repetition of LOC (Location Identification)
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)
ROL	insertROL(int rep) Inserts a specific repetition of ROL (Role)
void	insertROL(ROL structure, int rep) Inserts a specific repetition of ROL (Role)
ADJ	removeADJ(int rep) Removes a specific repetition of ADJ (Adjustment)
LOC	removeLOC(int rep) Removes a specific repetition of LOC (Location Identification)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
ROL	removeROL(int rep) Removes a specific repetition of ROL (Role)

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

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, removeRepetition, tryToInstantiateStructure

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

EHC_E20_PSL_ITEM_INFO

public EHC_E20_PSL_ITEM_INFO(Group parent,
                     ModelClassFactory factory)

Creates a new EHC_E20_PSL_ITEM_INFO group

Method Detail

getVersion

public String getVersion()

Returns "2.6"

getPSL

public PSL getPSL()

Returns PSL (Product/Service Line Item) - creates it if necessary

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)

getADJ

public ADJ getADJ()

Returns the first repetition of ADJ (Adjustment) - creates it if necessary

getADJ

public ADJ getADJ(int rep)

Returns a specific repetition of ADJ (Adjustment) - 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.

getADJReps

public int getADJReps()

Returns the number of existing repetitions of ADJ

getADJAll

public List<ADJ> getADJAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertADJ

public void insertADJ(ADJ structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of ADJ (Adjustment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertADJ

public ADJ insertADJ(int rep)
              throws HL7Exception

Inserts a specific repetition of ADJ (Adjustment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeADJ

public ADJ removeADJ(int rep)
              throws HL7Exception

Removes a specific repetition of ADJ (Adjustment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getLOC

public LOC getLOC()

Returns the first repetition of LOC (Location Identification) - creates it if necessary

getLOC

public LOC getLOC(int rep)

Returns a specific repetition of LOC (Location Identification) - 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.

getLOCReps

public int getLOCReps()

Returns the number of existing repetitions of LOC

getLOCAll

public List<LOC> getLOCAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertLOC

public void insertLOC(LOC structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of LOC (Location Identification)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertLOC

public LOC insertLOC(int rep)
              throws HL7Exception

Inserts a specific repetition of LOC (Location Identification)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeLOC

public LOC removeLOC(int rep)
              throws HL7Exception

Removes a specific repetition of LOC (Location Identification)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getROL

public ROL getROL()

Returns the first repetition of ROL (Role) - creates it if necessary

getROL

public ROL getROL(int rep)

Returns a specific repetition of ROL (Role) - 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.

getROLReps

public int getROLReps()

Returns the number of existing repetitions of ROL

getROLAll

public List<ROL> getROLAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertROL

public void insertROL(ROL structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertROL

public ROL insertROL(int rep)
              throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeROL

public ROL removeROL(int rep)
              throws HL7Exception

Removes a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)