PPT_PCL_PATHWAY (HAPI - Java HL7 API - Generated Structures v2.5.1 2.3 API)

java.lang.Object
- ca.uhn.hl7v2.model.AbstractStructure
- - ca.uhn.hl7v2.model.AbstractGroup
  - - ca.uhn.hl7v2.model.v251.group.PPT_PCL_PATHWAY

All Implemented Interfaces:

Group, Structure, Visitable, Serializable
```
public class PPT_PCL_PATHWAY
extends AbstractGroup
```
Represents a PPT_PCL_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) optional repeating
- 3: VAR (Variance) optional repeating
- 4: PPT_PCL_PATHWAY_ROLE (a Group object) optional repeating
- 5: PPT_PCL_GOAL (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 and Description

PPT_PCL_PATHWAY(Group parent, ModelClassFactory factory)
Creates a new PPT_PCL_PATHWAY group

Constructors
Constructor and Description
`PPT_PCL_PATHWAY(Group parent, ModelClassFactory factory)` Creates a new PPT_PCL_PATHWAY group

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PPT_PCL_GOAL`	`getGOAL()` Returns the first repetition of GOAL (a Group object) - creates it if necessary
`PPT_PCL_GOAL`	`getGOAL(int rep)` Returns a specific repetition of GOAL (a Group object) - creates it if necessary
`List<PPT_PCL_GOAL>`	`getGOALAll()` Returns a non-modifiable List containing all current existing repetitions of GOAL.
`int`	`getGOALReps()` Returns the number of existing repetitions of GOAL
`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
`PPT_PCL_PATHWAY_ROLE`	`getPATHWAY_ROLE()` Returns the first repetition of PATHWAY_ROLE (a Group object) - creates it if necessary
`PPT_PCL_PATHWAY_ROLE`	`getPATHWAY_ROLE(int rep)` Returns a specific repetition of PATHWAY_ROLE (a Group object) - creates it if necessary
`List<PPT_PCL_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
`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.5.1"
`PPT_PCL_GOAL`	`insertGOAL(int rep)` Inserts a specific repetition of GOAL (a Group object)
`void`	`insertGOAL(PPT_PCL_GOAL structure, int rep)` Inserts a specific repetition of GOAL (a Group object)
`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)
`PPT_PCL_PATHWAY_ROLE`	`insertPATHWAY_ROLE(int rep)` Inserts a specific repetition of PATHWAY_ROLE (a Group object)
`void`	`insertPATHWAY_ROLE(PPT_PCL_PATHWAY_ROLE structure, int rep)` Inserts a specific repetition of PATHWAY_ROLE (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)
`PPT_PCL_GOAL`	`removeGOAL(int rep)` Removes a specific repetition of GOAL (a Group object)
`NTE`	`removeNTE(int rep)` Removes a specific repetition of NTE (Notes and Comments)
`PPT_PCL_PATHWAY_ROLE`	`removePATHWAY_ROLE(int rep)` Removes a specific repetition of PATHWAY_ROLE (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 Detail
  - PPT_PCL_PATHWAY
```
public PPT_PCL_PATHWAY(Group parent,
                       ModelClassFactory factory)
```
    Creates a new PPT_PCL_PATHWAY group
- Method Detail
  - getVersion
```
public String getVersion()
```
    Returns "2.5.1"
  - getPTH
```
public PTH getPTH()
```
    Returns PTH (Pathway) - 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)
  - 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 PPT_PCL_PATHWAY_ROLE getPATHWAY_ROLE()
```
    Returns the first repetition of PATHWAY_ROLE (a Group object) - creates it if necessary
  - getPATHWAY_ROLE
```
public PPT_PCL_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<PPT_PCL_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(PPT_PCL_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 PPT_PCL_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 PPT_PCL_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)
  - getGOAL
```
public PPT_PCL_GOAL getGOAL()
```
    Returns the first repetition of GOAL (a Group object) - creates it if necessary
  - getGOAL
```
public PPT_PCL_GOAL getGOAL(int rep)
```
    Returns a specific repetition of GOAL (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.
  - getGOALReps
```
public int getGOALReps()
```
    Returns the number of existing repetitions of GOAL
  - getGOALAll
```
public List<PPT_PCL_GOAL> getGOALAll()
                              throws HL7Exception
```
    Returns a non-modifiable List containing all current existing repetitions of GOAL.
    
    Note that unlike getGOAL(), this method will not create any reps if none are already present, so an empty list may be returned.
    
    Throws:
    
    HL7Exception
  - insertGOAL
```
public void insertGOAL(PPT_PCL_GOAL structure,
                       int rep)
                throws HL7Exception
```
    Inserts a specific repetition of GOAL (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - insertGOAL
```
public PPT_PCL_GOAL insertGOAL(int rep)
                        throws HL7Exception
```
    Inserts a specific repetition of GOAL (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup#insertRepetition(Structure, int)
  - removeGOAL
```
public PPT_PCL_GOAL removeGOAL(int rep)
                        throws HL7Exception
```
    Removes a specific repetition of GOAL (a Group object)
    
    Throws:
    
    HL7Exception
    
    See Also:
    
    AbstractGroup.removeRepetition(String, int)

Class PPT_PCL_PATHWAY

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.hl7v2.model.Structure

Constructor Detail

PPT_PCL_PATHWAY

Method Detail

getVersion

getPTH

getNTE

getNTE

getNTEReps

getNTEAll

insertNTE

insertNTE

removeNTE

getVAR

getVAR

getVARReps

getVARAll

insertVAR

insertVAR

removeVAR

getPATHWAY_ROLE

getPATHWAY_ROLE

getPATHWAY_ROLEReps

getPATHWAY_ROLEAll

insertPATHWAY_ROLE

insertPATHWAY_ROLE

removePATHWAY_ROLE

getGOAL

getGOAL

getGOALReps

getGOALAll

insertGOAL

insertGOAL

removeGOAL