Package ca.uhn.hl7v2.model.v24.group

Class ADT_A05_PROCEDURE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.ADT_A05_PROCEDURE

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ADT_A05_PROCEDURE
extends AbstractGroup

Represents a ADT_A05_PROCEDURE 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: PR1 (Procedures)
• 2: ROL (Role) optional repeating

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
ADT_A05_PROCEDURE(Group parent, ModelClassFactory factory)	Creates a new ADT_A05_PROCEDURE group

Method Summary

Modifier and Type	Method	Description
PR1	getPR1()	Returns PR1 (Procedures) - creates it if necessary
ROL	getROL()	Returns the first repetition of ROL (Role) - creates it if necessary
ROL	getROL(int rep)	Returns a specific repetition of ROL (Role) - creates it if necessary
List<ROL>	getROLAll()	Returns a non-modifiable List containing all current existing repetitions of ROL.
int	getROLReps()	Returns the number of existing repetitions of ROL
String	getVersion()	Returns "2.4"
ROL	insertROL(int rep)	Inserts a specific repetition of ROL (Role)
void	insertROL(ROL structure, int rep)	Inserts a specific repetition of ROL (Role)
ROL	removeROL(int rep)	Removes a specific repetition of ROL (Role)

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 Details

ADT_A05_PROCEDURE

public ADT_A05_PROCEDURE(Group parent,
 ModelClassFactory factory)

Creates a new ADT_A05_PROCEDURE group

Method Details

getVersion

public String getVersion()

Returns "2.4"

getPR1

public PR1 getPR1()

Returns PR1 (Procedures) - creates it if necessary

getROL

public ROL getROL()

Returns the first repetition of ROL (Role) - creates it if necessary

getROL

public ROL getROL(int rep)

Returns a specific repetition of ROL (Role) - 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.

getROLReps

public int getROLReps()

Returns the number of existing repetitions of ROL

getROLAll

public List<ROL> getROLAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertROL

public void insertROL(ROL structure,
 int rep)
               throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertROL

public ROL insertROL(int rep)
              throws HL7Exception

Inserts a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeROL

public ROL removeROL(int rep)
              throws HL7Exception

Removes a specific repetition of ROL (Role)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)