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

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

All Implemented Interfaces:

Group, Structure, Serializable

public class PGL_PC6_GOAL_ROLE
extends AbstractGroup

Represents a PGL_PC6_GOAL_ROLE 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: ROL (Role)
• 2: VAR (Variance) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

ROL	getROL() Returns ROL (Role) - 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"
VAR	insertVAR(int rep) Inserts a specific repetition of VAR (Variance)
void	insertVAR(VAR structure, int rep) Inserts a specific repetition of VAR (Variance)
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

PGL_PC6_GOAL_ROLE

public PGL_PC6_GOAL_ROLE(Group parent,
                         ModelClassFactory factory)

Creates a new PGL_PC6_GOAL_ROLE group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getROL

public ROL getROL()

Returns ROL (Role) - creates it if necessary

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)