Package ca.uhn.hl7v2.model.v23.group

Class PPP_PCB_PATHWAY

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.PPP_PCB_PATHWAY

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class PPP_PCB_PATHWAY
extends AbstractGroup

Represents a PPP_PCB_PATHWAY 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: PTH (Pathway)
• 2: NTE (Notes and comments segment) optional repeating
• 3: VAR (Variance) optional repeating
• 4: PPP_PCB_PATHWAY_ROLE (a Group object) optional repeating
• 5: PPP_PCB_PROBLEM (a Group object) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
NTE	getNTE()	Returns the first repetition of NTE (Notes and comments segment) - creates it if necessary
NTE	getNTE(int rep)	Returns a specific repetition of NTE (Notes and comments segment) - 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
PPP_PCB_PATHWAY_ROLE	getPATHWAY_ROLE()	Returns the first repetition of PATHWAY_ROLE (a Group object) - creates it if necessary
PPP_PCB_PATHWAY_ROLE	getPATHWAY_ROLE(int rep)	Returns a specific repetition of PATHWAY_ROLE (a Group object) - creates it if necessary
List<PPP_PCB_PATHWAY_ROLE>	getPATHWAY_ROLEAll()	Returns a non-modifiable List containing all current existing repetitions of PATHWAY_ROLE.
int	getPATHWAY_ROLEReps()	Returns the number of existing repetitions of PATHWAY_ROLE
PPP_PCB_PROBLEM	getPROBLEM()	Returns the first repetition of PROBLEM (a Group object) - creates it if necessary
PPP_PCB_PROBLEM	getPROBLEM(int rep)	Returns a specific repetition of PROBLEM (a Group object) - creates it if necessary
List<PPP_PCB_PROBLEM>	getPROBLEMAll()	Returns a non-modifiable List containing all current existing repetitions of PROBLEM.
int	getPROBLEMReps()	Returns the number of existing repetitions of PROBLEM
PTH	getPTH()	Returns PTH (Pathway) - creates it if necessary
VAR	getVAR()	Returns the first repetition of VAR (Variance) - creates it if necessary
VAR	getVAR(int rep)	Returns a specific repetition of VAR (Variance) - creates it if necessary
List<VAR>	getVARAll()	Returns a non-modifiable List containing all current existing repetitions of VAR.
int	getVARReps()	Returns the number of existing repetitions of VAR
String	getVersion()	Returns "2.3"
NTE	insertNTE(int rep)	Inserts a specific repetition of NTE (Notes and comments segment)
void	insertNTE(NTE structure, int rep)	Inserts a specific repetition of NTE (Notes and comments segment)
PPP_PCB_PATHWAY_ROLE	insertPATHWAY_ROLE(int rep)	Inserts a specific repetition of PATHWAY_ROLE (a Group object)
void	insertPATHWAY_ROLE(PPP_PCB_PATHWAY_ROLE structure, int rep)	Inserts a specific repetition of PATHWAY_ROLE (a Group object)
PPP_PCB_PROBLEM	insertPROBLEM(int rep)	Inserts a specific repetition of PROBLEM (a Group object)
void	insertPROBLEM(PPP_PCB_PROBLEM structure, int rep)	Inserts a specific repetition of PROBLEM (a Group object)
VAR	insertVAR(int rep)	Inserts a specific repetition of VAR (Variance)
void	insertVAR(VAR structure, int rep)	Inserts a specific repetition of VAR (Variance)
NTE	removeNTE(int rep)	Removes a specific repetition of NTE (Notes and comments segment)
PPP_PCB_PATHWAY_ROLE	removePATHWAY_ROLE(int rep)	Removes a specific repetition of PATHWAY_ROLE (a Group object)
PPP_PCB_PROBLEM	removePROBLEM(int rep)	Removes a specific repetition of PROBLEM (a Group object)
VAR	removeVAR(int rep)	Removes a specific repetition of VAR (Variance)

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 Details

PPP_PCB_PATHWAY

public PPP_PCB_PATHWAY(Group parent,
 ModelClassFactory factory)

Creates a new PPP_PCB_PATHWAY group

Method Details

getVersion

public String getVersion()

Returns "2.3"

getPTH

public PTH getPTH()

Returns PTH (Pathway) - creates it if necessary

getNTE

public NTE getNTE()

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

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and comments segment) - 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 segment)

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 segment)

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 segment)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getVAR

public VAR getVAR()

Returns the first repetition of VAR (Variance) - creates it if necessary

getVAR

public VAR getVAR(int rep)

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

getVARReps

public int getVARReps()

Returns the number of existing repetitions of VAR

getVARAll

public List<VAR> getVARAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertVAR

public void insertVAR(VAR structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of VAR (Variance)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertVAR

public VAR insertVAR(int rep)
              throws HL7Exception

Inserts a specific repetition of VAR (Variance)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeVAR

public VAR removeVAR(int rep)
              throws HL7Exception

Removes a specific repetition of VAR (Variance)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPATHWAY_ROLE

public PPP_PCB_PATHWAY_ROLE getPATHWAY_ROLE()

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

getPATHWAY_ROLE

public PPP_PCB_PATHWAY_ROLE getPATHWAY_ROLE(int rep)

Returns a specific repetition of PATHWAY_ROLE (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.

getPATHWAY_ROLEReps

public int getPATHWAY_ROLEReps()

Returns the number of existing repetitions of PATHWAY_ROLE

getPATHWAY_ROLEAll

public List<PPP_PCB_PATHWAY_ROLE> getPATHWAY_ROLEAll()
                                              throws HL7Exception

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

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

Throws:

HL7Exception

insertPATHWAY_ROLE

public void insertPATHWAY_ROLE(PPP_PCB_PATHWAY_ROLE structure,
 int rep)
                        throws HL7Exception

Inserts a specific repetition of PATHWAY_ROLE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPATHWAY_ROLE

public PPP_PCB_PATHWAY_ROLE insertPATHWAY_ROLE(int rep)
                                        throws HL7Exception

Inserts a specific repetition of PATHWAY_ROLE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePATHWAY_ROLE

public PPP_PCB_PATHWAY_ROLE removePATHWAY_ROLE(int rep)
                                        throws HL7Exception

Removes a specific repetition of PATHWAY_ROLE (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)

getPROBLEM

public PPP_PCB_PROBLEM getPROBLEM()

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

getPROBLEM

public PPP_PCB_PROBLEM getPROBLEM(int rep)

Returns a specific repetition of PROBLEM (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.

getPROBLEMReps

public int getPROBLEMReps()

Returns the number of existing repetitions of PROBLEM

getPROBLEMAll

public List<PPP_PCB_PROBLEM> getPROBLEMAll()
                                    throws HL7Exception

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

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

Throws:

HL7Exception

insertPROBLEM

public void insertPROBLEM(PPP_PCB_PROBLEM structure,
 int rep)
                   throws HL7Exception

Inserts a specific repetition of PROBLEM (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertPROBLEM

public PPP_PCB_PROBLEM insertPROBLEM(int rep)
                              throws HL7Exception

Inserts a specific repetition of PROBLEM (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removePROBLEM

public PPP_PCB_PROBLEM removePROBLEM(int rep)
                              throws HL7Exception

Removes a specific repetition of PROBLEM (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)