ca.uhn.hl7v2.model.v24.group
Class PPG_PCG_PATHWAY

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v24.group.PPG_PCG_PATHWAY

All Implemented Interfaces:

Group, Structure, Serializable

public class PPG_PCG_PATHWAY
extends AbstractGroup

Represents a PPG_PCG_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: PPG_PCG_PATHWAY_ROLE (a Group object) optional repeating
• 5: PPG_PCG_GOAL (a Group object) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

PPG_PCG_GOAL	getGOAL() Returns the first repetition of GOAL (a Group object) - creates it if necessary
PPG_PCG_GOAL	getGOAL(int rep) Returns a specific repetition of GOAL (a Group object) - creates it if necessary
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
int	getNTEReps() Returns the number of existing repetitions of NTE
PPG_PCG_PATHWAY_ROLE	getPATHWAY_ROLE() Returns the first repetition of PATHWAY_ROLE (a Group object) - creates it if necessary
PPG_PCG_PATHWAY_ROLE	getPATHWAY_ROLE(int rep) Returns a specific repetition of PATHWAY_ROLE (a Group object) - creates it if necessary
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
int	getVARReps() Returns the number of existing repetitions of VAR
String	getVersion() Returns "2.4"
PPG_PCG_GOAL	insertGOAL(int rep) Inserts a specific repetition of GOAL (a Group object)
void	insertGOAL(PPG_PCG_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)
PPG_PCG_PATHWAY_ROLE	insertPATHWAY_ROLE(int rep) Inserts a specific repetition of PATHWAY_ROLE (a Group object)
void	insertPATHWAY_ROLE(PPG_PCG_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)
PPG_PCG_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)
PPG_PCG_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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getClass, getMessage, getModelClassFactory, getName, getNames, getParent, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PPG_PCG_PATHWAY

public PPG_PCG_PATHWAY(Group parent,
                       ModelClassFactory factory)

Creates a new PPG_PCG_PATHWAY group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

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

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

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 PPG_PCG_PATHWAY_ROLE getPATHWAY_ROLE()

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

getPATHWAY_ROLE

public PPG_PCG_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

insertPATHWAY_ROLE

public void insertPATHWAY_ROLE(PPG_PCG_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 PPG_PCG_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 PPG_PCG_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 PPG_PCG_GOAL getGOAL()

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

getGOAL

public PPG_PCG_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

insertGOAL

public void insertGOAL(PPG_PCG_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 PPG_PCG_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 PPG_PCG_GOAL removeGOAL(int rep)
                        throws HL7Exception

Removes a specific repetition of GOAL (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)