ca.uhn.hl7v2.model.v281.message

Class SDR_S32

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v281.message.SDR_S32

All Implemented Interfaces:

Group, Message, Structure, Visitable, Serializable

public class SDR_S32
extends AbstractMessage

Represents a SDR_S32 message structure (see chapter 17.5.5). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: UAC (User Authentication Credential Segment) optional
• 4: SDD (Sterilization Device Data)
• 5: SCD (Anti-Microbial Cycle Data) optional repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
SDR_S32() Creates a new SDR_S32 message with DefaultModelClassFactory.
SDR_S32(ModelClassFactory factory) Creates a new SDR_S32 message with custom ModelClassFactory.

Method Summary

Modifier and Type	Method and Description
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
SCD	getSCD() Returns the first repetition of SCD (Anti-Microbial Cycle Data) - creates it if necessary
SCD	getSCD(int rep) Returns a specific repetition of SCD (Anti-Microbial Cycle Data) - creates it if necessary
List<SCD>	getSCDAll() Returns a non-modifiable List containing all current existing repetitions of SCD.
int	getSCDReps() Returns the number of existing repetitions of SCD
SDD	getSDD() Returns SDD (Sterilization Device Data) - creates it if necessary
SFT	getSFT() Returns the first repetition of SFT (Software Segment) - creates it if necessary
SFT	getSFT(int rep) Returns a specific repetition of SFT (Software Segment) - creates it if necessary
List<SFT>	getSFTAll() Returns a non-modifiable List containing all current existing repetitions of SFT.
int	getSFTReps() Returns the number of existing repetitions of SFT
UAC	getUAC() Returns UAC (User Authentication Credential Segment) - creates it if necessary
String	getVersion() Returns "2.8.1"
SCD	insertSCD(int rep) Inserts a specific repetition of SCD (Anti-Microbial Cycle Data)
void	insertSCD(SCD structure, int rep) Inserts a specific repetition of SCD (Anti-Microbial Cycle Data)
SFT	insertSFT(int rep) Inserts a specific repetition of SFT (Software Segment)
void	insertSFT(SFT structure, int rep) Inserts a specific repetition of SFT (Software Segment)
SCD	removeSCD(int rep) Removes a specific repetition of SCD (Anti-Microbial Cycle Data)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)

Methods inherited from class ca.uhn.hl7v2.model.AbstractMessage

accept, encode, fillResponseHeader, generateACK, generateACK, generateACK, getEncodingCharactersValue, getFieldSeparatorValue, getMessage, getParent, getParser, getValidationContext, initQuickstart, parse, printStructure, printStructure, setParser, toString

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Group

addNonstandardSegment, addNonstandardSegment, get, get, getAll, getClass, getNames, isChoiceElement, isGroup, isRepeating, isRequired

Methods inherited from interface ca.uhn.hl7v2.model.Structure

getName

Methods inherited from interface ca.uhn.hl7v2.model.Visitable

isEmpty, provideLocation

Constructor Detail

SDR_S32

public SDR_S32()

Creates a new SDR_S32 message with DefaultModelClassFactory.

SDR_S32

public SDR_S32(ModelClassFactory factory)

Creates a new SDR_S32 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.8.1"

Specified by:

getVersion in interface Message

Overrides:

getVersion in class AbstractMessage

getMSH

public MSH getMSH()

Returns MSH (Message Header) - creates it if necessary

getSFT

public SFT getSFT()

Returns the first repetition of SFT (Software Segment) - creates it if necessary

getSFT

public SFT getSFT(int rep)

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

getSFTReps

public int getSFTReps()

Returns the number of existing repetitions of SFT

getSFTAll

public List<SFT> getSFTAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSFT

public void insertSFT(SFT structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSFT

public SFT insertSFT(int rep)
              throws HL7Exception

Inserts a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSFT

public SFT removeSFT(int rep)
              throws HL7Exception

Removes a specific repetition of SFT (Software Segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getUAC

public UAC getUAC()

Returns UAC (User Authentication Credential Segment) - creates it if necessary

getSDD

public SDD getSDD()

Returns SDD (Sterilization Device Data) - creates it if necessary

getSCD

public SCD getSCD()

Returns the first repetition of SCD (Anti-Microbial Cycle Data) - creates it if necessary

getSCD

public SCD getSCD(int rep)

Returns a specific repetition of SCD (Anti-Microbial Cycle Data) - 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.

getSCDReps

public int getSCDReps()

Returns the number of existing repetitions of SCD

getSCDAll

public List<SCD> getSCDAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSCD

public void insertSCD(SCD structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of SCD (Anti-Microbial Cycle Data)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSCD

public SCD insertSCD(int rep)
              throws HL7Exception

Inserts a specific repetition of SCD (Anti-Microbial Cycle Data)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSCD

public SCD removeSCD(int rep)
              throws HL7Exception

Removes a specific repetition of SCD (Anti-Microbial Cycle Data)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)