ca.uhn.hl7v2.model.v231.group
Class PGL_PC6_GOLNTEVARROLVARPTHVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

java.lang.Object
  ca.uhn.hl7v2.model.AbstractGroup
      ca.uhn.hl7v2.model.v231.group.PGL_PC6_GOLNTEVARROLVARPTHVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

All Implemented Interfaces:

Group, Structure, Serializable

public class PGL_PC6_GOLNTEVARROLVARPTHVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR
extends AbstractGroup

Represents a PGL_PC6_GOLNTEVARROLVARPTHVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR 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: GOL (Goal Detail)
• 2: NTE (NTE - notes and comments segment) optional repeating
• 3: VAR (Variance) optional repeating
• 4: PGL_PC6_ROLVAR (a Group object) optional repeating
• 5: PGL_PC6_PTHVAR (a Group object) optional repeating
• 6: PGL_PC6_OBXNTE (a Group object) optional repeating
• 7: PGL_PC6_PRBNTEVARROLVAROBXNTE (a Group object) optional repeating
• 8: PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR (a Group object) optional repeating

See Also:

Serialized Form

Constructor Summary

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

Method Summary

GOL	getGOL() Returns GOL (Goal Detail) - creates it if necessary
NTE	getNTE() Returns the first repetition of NTE (NTE - notes and comments segment) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (NTE - notes and comments segment) - creates it if necessary
int	getNTEReps() Returns the number of existing repetitions of NTE
PGL_PC6_OBXNTE	getOBXNTE() Returns the first repetition of OBXNTE (a Group object) - creates it if necessary
PGL_PC6_OBXNTE	getOBXNTE(int rep) Returns a specific repetition of OBXNTE (a Group object) - creates it if necessary
int	getOBXNTEReps() Returns the number of existing repetitions of OBXNTE
PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR	getORCOBRRXONTEVAROBXNTEVAR() Returns the first repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object) - creates it if necessary
PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR	getORCOBRRXONTEVAROBXNTEVAR(int rep) Returns a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object) - creates it if necessary
int	getORCOBRRXONTEVAROBXNTEVARReps() Returns the number of existing repetitions of ORCOBRRXONTEVAROBXNTEVAR
PGL_PC6_PRBNTEVARROLVAROBXNTE	getPRBNTEVARROLVAROBXNTE() Returns the first repetition of PRBNTEVARROLVAROBXNTE (a Group object) - creates it if necessary
PGL_PC6_PRBNTEVARROLVAROBXNTE	getPRBNTEVARROLVAROBXNTE(int rep) Returns a specific repetition of PRBNTEVARROLVAROBXNTE (a Group object) - creates it if necessary
int	getPRBNTEVARROLVAROBXNTEReps() Returns the number of existing repetitions of PRBNTEVARROLVAROBXNTE
PGL_PC6_PTHVAR	getPTHVAR() Returns the first repetition of PTHVAR (a Group object) - creates it if necessary
PGL_PC6_PTHVAR	getPTHVAR(int rep) Returns a specific repetition of PTHVAR (a Group object) - creates it if necessary
int	getPTHVARReps() Returns the number of existing repetitions of PTHVAR
PGL_PC6_ROLVAR	getROLVAR() Returns the first repetition of ROLVAR (a Group object) - creates it if necessary
PGL_PC6_ROLVAR	getROLVAR(int rep) Returns a specific repetition of ROLVAR (a Group object) - creates it if necessary
int	getROLVARReps() Returns the number of existing repetitions of ROLVAR
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.3.1"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (NTE - notes and comments segment)
PGL_PC6_OBXNTE	insertOBXNTE(int rep) Inserts a specific repetition of OBXNTE (a Group object)
void	insertOBXNTE(PGL_PC6_OBXNTE structure, int rep) Inserts a specific repetition of OBXNTE (a Group object)
PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR	insertORCOBRRXONTEVAROBXNTEVAR(int rep) Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)
void	insertORCOBRRXONTEVAROBXNTEVAR(PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR structure, int rep) Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)
PGL_PC6_PRBNTEVARROLVAROBXNTE	insertPRBNTEVARROLVAROBXNTE(int rep) Inserts a specific repetition of PRBNTEVARROLVAROBXNTE (a Group object)
void	insertPRBNTEVARROLVAROBXNTE(PGL_PC6_PRBNTEVARROLVAROBXNTE structure, int rep) Inserts a specific repetition of PRBNTEVARROLVAROBXNTE (a Group object)
PGL_PC6_PTHVAR	insertPTHVAR(int rep) Inserts a specific repetition of PTHVAR (a Group object)
void	insertPTHVAR(PGL_PC6_PTHVAR structure, int rep) Inserts a specific repetition of PTHVAR (a Group object)
PGL_PC6_ROLVAR	insertROLVAR(int rep) Inserts a specific repetition of ROLVAR (a Group object)
void	insertROLVAR(PGL_PC6_ROLVAR structure, int rep) Inserts a specific repetition of ROLVAR (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 (NTE - notes and comments segment)
PGL_PC6_OBXNTE	removeOBXNTE(int rep) Removes a specific repetition of OBXNTE (a Group object)
PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR	removeORCOBRRXONTEVAROBXNTEVAR(int rep) Removes a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)
PGL_PC6_PRBNTEVARROLVAROBXNTE	removePRBNTEVARROLVAROBXNTE(int rep) Removes a specific repetition of PRBNTEVARROLVAROBXNTE (a Group object)
PGL_PC6_PTHVAR	removePTHVAR(int rep) Removes a specific repetition of PTHVAR (a Group object)
PGL_PC6_ROLVAR	removeROLVAR(int rep) Removes a specific repetition of ROLVAR (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

PGL_PC6_GOLNTEVARROLVARPTHVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR

public PGL_PC6_GOLNTEVARROLVARPTHVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(Group parent,
                                                                                        ModelClassFactory factory)

Creates a new PGL_PC6_GOLNTEVARROLVARPTHVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getGOL

public GOL getGOL()

Returns GOL (Goal Detail) - creates it if necessary

getNTE

public NTE getNTE()

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

getNTE

public NTE getNTE(int rep)

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

insertNTE

public void insertNTE(NTE structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (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 (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 (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

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)

getROLVAR

public PGL_PC6_ROLVAR getROLVAR()

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

getROLVAR

public PGL_PC6_ROLVAR getROLVAR(int rep)

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

getROLVARReps

public int getROLVARReps()

Returns the number of existing repetitions of ROLVAR

insertROLVAR

public void insertROLVAR(PGL_PC6_ROLVAR structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of ROLVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertROLVAR

public PGL_PC6_ROLVAR insertROLVAR(int rep)
                            throws HL7Exception

Inserts a specific repetition of ROLVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeROLVAR

public PGL_PC6_ROLVAR removeROLVAR(int rep)
                            throws HL7Exception

Removes a specific repetition of ROLVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPTHVAR

public PGL_PC6_PTHVAR getPTHVAR()

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

getPTHVAR

public PGL_PC6_PTHVAR getPTHVAR(int rep)

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

getPTHVARReps

public int getPTHVARReps()

Returns the number of existing repetitions of PTHVAR

insertPTHVAR

public void insertPTHVAR(PGL_PC6_PTHVAR structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of PTHVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPTHVAR

public PGL_PC6_PTHVAR insertPTHVAR(int rep)
                            throws HL7Exception

Inserts a specific repetition of PTHVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePTHVAR

public PGL_PC6_PTHVAR removePTHVAR(int rep)
                            throws HL7Exception

Removes a specific repetition of PTHVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getOBXNTE

public PGL_PC6_OBXNTE getOBXNTE()

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

getOBXNTE

public PGL_PC6_OBXNTE getOBXNTE(int rep)

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

getOBXNTEReps

public int getOBXNTEReps()

Returns the number of existing repetitions of OBXNTE

insertOBXNTE

public void insertOBXNTE(PGL_PC6_OBXNTE structure,
                         int rep)
                  throws HL7Exception

Inserts a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertOBXNTE

public PGL_PC6_OBXNTE insertOBXNTE(int rep)
                            throws HL7Exception

Inserts a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeOBXNTE

public PGL_PC6_OBXNTE removeOBXNTE(int rep)
                            throws HL7Exception

Removes a specific repetition of OBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPRBNTEVARROLVAROBXNTE

public PGL_PC6_PRBNTEVARROLVAROBXNTE getPRBNTEVARROLVAROBXNTE()

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

getPRBNTEVARROLVAROBXNTE

public PGL_PC6_PRBNTEVARROLVAROBXNTE getPRBNTEVARROLVAROBXNTE(int rep)

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

getPRBNTEVARROLVAROBXNTEReps

public int getPRBNTEVARROLVAROBXNTEReps()

Returns the number of existing repetitions of PRBNTEVARROLVAROBXNTE

insertPRBNTEVARROLVAROBXNTE

public void insertPRBNTEVARROLVAROBXNTE(PGL_PC6_PRBNTEVARROLVAROBXNTE structure,
                                        int rep)
                                 throws HL7Exception

Inserts a specific repetition of PRBNTEVARROLVAROBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertPRBNTEVARROLVAROBXNTE

public PGL_PC6_PRBNTEVARROLVAROBXNTE insertPRBNTEVARROLVAROBXNTE(int rep)
                                                          throws HL7Exception

Inserts a specific repetition of PRBNTEVARROLVAROBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removePRBNTEVARROLVAROBXNTE

public PGL_PC6_PRBNTEVARROLVAROBXNTE removePRBNTEVARROLVAROBXNTE(int rep)
                                                          throws HL7Exception

Removes a specific repetition of PRBNTEVARROLVAROBXNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getORCOBRRXONTEVAROBXNTEVAR

public PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR getORCOBRRXONTEVAROBXNTEVAR()

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

getORCOBRRXONTEVAROBXNTEVAR

public PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR getORCOBRRXONTEVAROBXNTEVAR(int rep)

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

getORCOBRRXONTEVAROBXNTEVARReps

public int getORCOBRRXONTEVAROBXNTEVARReps()

Returns the number of existing repetitions of ORCOBRRXONTEVAROBXNTEVAR

insertORCOBRRXONTEVAROBXNTEVAR

public void insertORCOBRRXONTEVAROBXNTEVAR(PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR structure,
                                           int rep)
                                    throws HL7Exception

Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORCOBRRXONTEVAROBXNTEVAR

public PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR insertORCOBRRXONTEVAROBXNTEVAR(int rep)
                                                                throws HL7Exception

Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORCOBRRXONTEVAROBXNTEVAR

public PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR removeORCOBRRXONTEVAROBXNTEVAR(int rep)
                                                                throws HL7Exception

Removes a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)