ca.uhn.hl7v2.model.v231.group

Class SUR_P09_FACPSHPDCPSHFACPDCNTE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.SUR_P09_FACPSHPDCPSHFACPDCNTE

All Implemented Interfaces:

Group, Structure, Serializable

public class SUR_P09_FACPSHPDCPSHFACPDCNTE
extends AbstractGroup

Represents a SUR_P09_FACPSHPDCPSHFACPDCNTE 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: FAC (FAC - facility segment)
• 2: SUR_P09_PSHPDC (a Group object) repeating
• 3: PSH (PSH - product summary header segment)
• 4: SUR_P09_FACPDCNTE (a Group object) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
FAC	getFAC() Returns FAC (FAC - facility segment) - creates it if necessary
SUR_P09_FACPDCNTE	getFACPDCNTE() Returns the first repetition of FACPDCNTE (a Group object) - creates it if necessary
SUR_P09_FACPDCNTE	getFACPDCNTE(int rep) Returns a specific repetition of FACPDCNTE (a Group object) - creates it if necessary
List<SUR_P09_FACPDCNTE>	getFACPDCNTEAll() Returns a non-modifiable List containing all current existing repetitions of FACPDCNTE.
int	getFACPDCNTEReps() Returns the number of existing repetitions of FACPDCNTE
PSH	getPSH() Returns PSH (PSH - product summary header segment) - creates it if necessary
SUR_P09_PSHPDC	getPSHPDC() Returns the first repetition of PSHPDC (a Group object) - creates it if necessary
SUR_P09_PSHPDC	getPSHPDC(int rep) Returns a specific repetition of PSHPDC (a Group object) - creates it if necessary
List<SUR_P09_PSHPDC>	getPSHPDCAll() Returns a non-modifiable List containing all current existing repetitions of PSHPDC.
int	getPSHPDCReps() Returns the number of existing repetitions of PSHPDC
String	getVersion() Returns "2.3.1"
SUR_P09_FACPDCNTE	insertFACPDCNTE(int rep) Inserts a specific repetition of FACPDCNTE (a Group object)
void	insertFACPDCNTE(SUR_P09_FACPDCNTE structure, int rep) Inserts a specific repetition of FACPDCNTE (a Group object)
SUR_P09_PSHPDC	insertPSHPDC(int rep) Inserts a specific repetition of PSHPDC (a Group object)
void	insertPSHPDC(SUR_P09_PSHPDC structure, int rep) Inserts a specific repetition of PSHPDC (a Group object)
SUR_P09_FACPDCNTE	removeFACPDCNTE(int rep) Removes a specific repetition of FACPDCNTE (a Group object)
SUR_P09_PSHPDC	removePSHPDC(int rep) Removes a specific repetition of PSHPDC (a Group object)

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, 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

SUR_P09_FACPSHPDCPSHFACPDCNTE

public SUR_P09_FACPSHPDCPSHFACPDCNTE(Group parent,
                             ModelClassFactory factory)

Creates a new SUR_P09_FACPSHPDCPSHFACPDCNTE group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getFAC

public FAC getFAC()

Returns FAC (FAC - facility segment) - creates it if necessary

getPSHPDC

public SUR_P09_PSHPDC getPSHPDC()

Returns the first repetition of PSHPDC (a Group object) - creates it if necessary

getPSHPDC

public SUR_P09_PSHPDC getPSHPDC(int rep)

Returns a specific repetition of PSHPDC (a Group object) - 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.

getPSHPDCReps

public int getPSHPDCReps()

Returns the number of existing repetitions of PSHPDC

getPSHPDCAll

public List<SUR_P09_PSHPDC> getPSHPDCAll()
                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertPSHPDC

public void insertPSHPDC(SUR_P09_PSHPDC structure,
                int rep)
                  throws HL7Exception

Inserts a specific repetition of PSHPDC (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPSHPDC

public SUR_P09_PSHPDC insertPSHPDC(int rep)
                            throws HL7Exception

Inserts a specific repetition of PSHPDC (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePSHPDC

public SUR_P09_PSHPDC removePSHPDC(int rep)
                            throws HL7Exception

Removes a specific repetition of PSHPDC (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPSH

public PSH getPSH()

Returns PSH (PSH - product summary header segment) - creates it if necessary

getFACPDCNTE

public SUR_P09_FACPDCNTE getFACPDCNTE()

Returns the first repetition of FACPDCNTE (a Group object) - creates it if necessary

getFACPDCNTE

public SUR_P09_FACPDCNTE getFACPDCNTE(int rep)

Returns a specific repetition of FACPDCNTE (a Group object) - 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.

getFACPDCNTEReps

public int getFACPDCNTEReps()

Returns the number of existing repetitions of FACPDCNTE

getFACPDCNTEAll

public List<SUR_P09_FACPDCNTE> getFACPDCNTEAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertFACPDCNTE

public void insertFACPDCNTE(SUR_P09_FACPDCNTE structure,
                   int rep)
                     throws HL7Exception

Inserts a specific repetition of FACPDCNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertFACPDCNTE

public SUR_P09_FACPDCNTE insertFACPDCNTE(int rep)
                                  throws HL7Exception

Inserts a specific repetition of FACPDCNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeFACPDCNTE

public SUR_P09_FACPDCNTE removeFACPDCNTE(int rep)
                                  throws HL7Exception

Removes a specific repetition of FACPDCNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)