ca.uhn.hl7v2.model.v281.group

Class EHC_E02_PSG

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v281.group.EHC_E02_PSG

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class EHC_E02_PSG
extends AbstractGroup

Represents a EHC_E02_PSG 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: PSG (Product/Service Group) choice
• 2: PSL (Product/Service Line Item) 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_E02_PSG(Group parent, ModelClassFactory factory) Creates a new EHC_E02_PSG group

Method Summary

Modifier and Type	Method and Description
PSG	getPSG() Returns PSG (Product/Service Group) - creates it if necessary
PSL	getPSL() Returns the first repetition of PSL (Product/Service Line Item) - creates it if necessary
PSL	getPSL(int rep) Returns a specific repetition of PSL (Product/Service Line Item) - creates it if necessary
List<PSL>	getPSLAll() Returns a non-modifiable List containing all current existing repetitions of PSL.
int	getPSLReps() Returns the number of existing repetitions of PSL
String	getVersion() Returns "2.8.1"
PSL	insertPSL(int rep) Inserts a specific repetition of PSL (Product/Service Line Item)
void	insertPSL(PSL structure, int rep) Inserts a specific repetition of PSL (Product/Service Line Item)
PSL	removePSL(int rep) Removes a specific repetition of PSL (Product/Service Line Item)

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

EHC_E02_PSG

public EHC_E02_PSG(Group parent,
                   ModelClassFactory factory)

Creates a new EHC_E02_PSG group

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

getPSG

public PSG getPSG()

Returns PSG (Product/Service Group) - creates it if necessary

getPSL

public PSL getPSL()

Returns the first repetition of PSL (Product/Service Line Item) - creates it if necessary

getPSL

public PSL getPSL(int rep)

Returns a specific repetition of PSL (Product/Service Line Item) - 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.

getPSLReps

public int getPSLReps()

Returns the number of existing repetitions of PSL

getPSLAll

public List<PSL> getPSLAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPSL

public void insertPSL(PSL structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of PSL (Product/Service Line Item)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPSL

public PSL insertPSL(int rep)
              throws HL7Exception

Inserts a specific repetition of PSL (Product/Service Line Item)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePSL

public PSL removePSL(int rep)
              throws HL7Exception

Removes a specific repetition of PSL (Product/Service Line Item)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)