ca.uhn.hl7v2.model.v24.group

Class PTR_PCF_GOAL

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.PTR_PCF_GOAL

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class PTR_PCF_GOAL
extends AbstractGroup

Represents a PTR_PCF_GOAL 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 (Notes and Comments) optional repeating
• 3: VAR (Variance) optional repeating
• 4: PTR_PCF_GOAL_ROLE (a Group object) optional repeating
• 5: PTR_PCF_GOAL_OBSERVATION (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
PTR_PCF_GOAL(Group parent, ModelClassFactory factory) Creates a new PTR_PCF_GOAL group

Method Summary

Modifier and Type	Method and Description
PTR_PCF_GOAL_OBSERVATION	getGOAL_OBSERVATION() Returns the first repetition of GOAL_OBSERVATION (a Group object) - creates it if necessary
PTR_PCF_GOAL_OBSERVATION	getGOAL_OBSERVATION(int rep) Returns a specific repetition of GOAL_OBSERVATION (a Group object) - creates it if necessary
List<PTR_PCF_GOAL_OBSERVATION>	getGOAL_OBSERVATIONAll() Returns a non-modifiable List containing all current existing repetitions of GOAL_OBSERVATION.
int	getGOAL_OBSERVATIONReps() Returns the number of existing repetitions of GOAL_OBSERVATION
PTR_PCF_GOAL_ROLE	getGOAL_ROLE() Returns the first repetition of GOAL_ROLE (a Group object) - creates it if necessary
PTR_PCF_GOAL_ROLE	getGOAL_ROLE(int rep) Returns a specific repetition of GOAL_ROLE (a Group object) - creates it if necessary
List<PTR_PCF_GOAL_ROLE>	getGOAL_ROLEAll() Returns a non-modifiable List containing all current existing repetitions of GOAL_ROLE.
int	getGOAL_ROLEReps() Returns the number of existing repetitions of GOAL_ROLE
GOL	getGOL() Returns GOL (Goal Detail) - creates it if necessary
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
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.4"
PTR_PCF_GOAL_OBSERVATION	insertGOAL_OBSERVATION(int rep) Inserts a specific repetition of GOAL_OBSERVATION (a Group object)
void	insertGOAL_OBSERVATION(PTR_PCF_GOAL_OBSERVATION structure, int rep) Inserts a specific repetition of GOAL_OBSERVATION (a Group object)
PTR_PCF_GOAL_ROLE	insertGOAL_ROLE(int rep) Inserts a specific repetition of GOAL_ROLE (a Group object)
void	insertGOAL_ROLE(PTR_PCF_GOAL_ROLE structure, int rep) Inserts a specific repetition of GOAL_ROLE (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)
VAR	insertVAR(int rep) Inserts a specific repetition of VAR (Variance)
void	insertVAR(VAR structure, int rep) Inserts a specific repetition of VAR (Variance)
PTR_PCF_GOAL_OBSERVATION	removeGOAL_OBSERVATION(int rep) Removes a specific repetition of GOAL_OBSERVATION (a Group object)
PTR_PCF_GOAL_ROLE	removeGOAL_ROLE(int rep) Removes a specific repetition of GOAL_ROLE (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and Comments)
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

PTR_PCF_GOAL

public PTR_PCF_GOAL(Group parent,
                    ModelClassFactory factory)

Creates a new PTR_PCF_GOAL group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getGOL

public GOL getGOL()

Returns GOL (Goal Detail) - 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)

getGOAL_ROLE

public PTR_PCF_GOAL_ROLE getGOAL_ROLE()

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

getGOAL_ROLE

public PTR_PCF_GOAL_ROLE getGOAL_ROLE(int rep)

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

getGOAL_ROLEReps

public int getGOAL_ROLEReps()

Returns the number of existing repetitions of GOAL_ROLE

getGOAL_ROLEAll

public List<PTR_PCF_GOAL_ROLE> getGOAL_ROLEAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertGOAL_ROLE

public void insertGOAL_ROLE(PTR_PCF_GOAL_ROLE structure,
                            int rep)
                     throws HL7Exception

Inserts a specific repetition of GOAL_ROLE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertGOAL_ROLE

public PTR_PCF_GOAL_ROLE insertGOAL_ROLE(int rep)
                                  throws HL7Exception

Inserts a specific repetition of GOAL_ROLE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeGOAL_ROLE

public PTR_PCF_GOAL_ROLE removeGOAL_ROLE(int rep)
                                  throws HL7Exception

Removes a specific repetition of GOAL_ROLE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getGOAL_OBSERVATION

public PTR_PCF_GOAL_OBSERVATION getGOAL_OBSERVATION()

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

getGOAL_OBSERVATION

public PTR_PCF_GOAL_OBSERVATION getGOAL_OBSERVATION(int rep)

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

getGOAL_OBSERVATIONReps

public int getGOAL_OBSERVATIONReps()

Returns the number of existing repetitions of GOAL_OBSERVATION

getGOAL_OBSERVATIONAll

public List<PTR_PCF_GOAL_OBSERVATION> getGOAL_OBSERVATIONAll()
                                                      throws HL7Exception

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

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

Throws:

HL7Exception

insertGOAL_OBSERVATION

public void insertGOAL_OBSERVATION(PTR_PCF_GOAL_OBSERVATION structure,
                                   int rep)
                            throws HL7Exception

Inserts a specific repetition of GOAL_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertGOAL_OBSERVATION

public PTR_PCF_GOAL_OBSERVATION insertGOAL_OBSERVATION(int rep)
                                                throws HL7Exception

Inserts a specific repetition of GOAL_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeGOAL_OBSERVATION

public PTR_PCF_GOAL_OBSERVATION removeGOAL_OBSERVATION(int rep)
                                                throws HL7Exception

Removes a specific repetition of GOAL_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)