ca.uhn.hl7v2.model.v25.group

Class SSR_U04_SPECIMEN_CONTAINER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v25.group.SSR_U04_SPECIMEN_CONTAINER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class SSR_U04_SPECIMEN_CONTAINER
extends AbstractGroup

Represents a SSR_U04_SPECIMEN_CONTAINER 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: SAC (Specimen Container detail)
• 2: SPM (Specimen) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SAC	getSAC() Returns SAC (Specimen Container detail) - creates it if necessary
SPM	getSPM() Returns the first repetition of SPM (Specimen) - creates it if necessary
SPM	getSPM(int rep) Returns a specific repetition of SPM (Specimen) - creates it if necessary
List<SPM>	getSPMAll() Returns a non-modifiable List containing all current existing repetitions of SPM.
int	getSPMReps() Returns the number of existing repetitions of SPM
String	getVersion() Returns "2.5"
SPM	insertSPM(int rep) Inserts a specific repetition of SPM (Specimen)
void	insertSPM(SPM structure, int rep) Inserts a specific repetition of SPM (Specimen)
SPM	removeSPM(int rep) Removes a specific repetition of SPM (Specimen)

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

SSR_U04_SPECIMEN_CONTAINER

public SSR_U04_SPECIMEN_CONTAINER(Group parent,
                                  ModelClassFactory factory)

Creates a new SSR_U04_SPECIMEN_CONTAINER group

Method Detail

getVersion

public String getVersion()

Returns "2.5"

getSAC

public SAC getSAC()

Returns SAC (Specimen Container detail) - creates it if necessary

getSPM

public SPM getSPM()

Returns the first repetition of SPM (Specimen) - creates it if necessary

getSPM

public SPM getSPM(int rep)

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

getSPMReps

public int getSPMReps()

Returns the number of existing repetitions of SPM

getSPMAll

public List<SPM> getSPMAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSPM

public void insertSPM(SPM structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of SPM (Specimen)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSPM

public SPM insertSPM(int rep)
              throws HL7Exception

Inserts a specific repetition of SPM (Specimen)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSPM

public SPM removeSPM(int rep)
              throws HL7Exception

Removes a specific repetition of SPM (Specimen)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)