ca.uhn.hl7v2.model.v26.message

Class STC_S33

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.AbstractMessage

ca.uhn.hl7v2.model.v26.message.STC_S33

All Implemented Interfaces:

Group, Message, Structure, Serializable

public class STC_S33
extends AbstractMessage

Represents a STC_S33 message structure (see chapter 17.6.1). This structure contains the following elements:

• 1: MSH (Message Header)
• 2: SFT (Software Segment) optional repeating
• 3: UAC (User Authentication Credential Segment) optional
• 4: SCP (Sterilizer Configuration Segment) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MSH	getMSH() Returns MSH (Message Header) - creates it if necessary
SCP	getSCP() Returns the first repetition of SCP (Sterilizer Configuration Segment) - creates it if necessary
SCP	getSCP(int rep) Returns a specific repetition of SCP (Sterilizer Configuration Segment) - creates it if necessary
List<SCP>	getSCPAll() Returns a non-modifiable List containing all current existing repetitions of SCP.
int	getSCPReps() Returns the number of existing repetitions of SCP
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.6"
SCP	insertSCP(int rep) Inserts a specific repetition of SCP (Sterilizer Configuration Segment)
void	insertSCP(SCP structure, int rep) Inserts a specific repetition of SCP (Sterilizer Configuration Segment)
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)
SCP	removeSCP(int rep) Removes a specific repetition of SCP (Sterilizer Configuration Segment)
SFT	removeSFT(int rep) Removes a specific repetition of SFT (Software Segment)

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

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

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

add, add, addNonstandardSegment, addNonstandardSegment, clear, currentReps, get, get, getAll, getAllAsList, getClass, getFieldNumForName, getModelClassFactory, getName, getNames, getNonStandardNames, getReps, getTyped, getTyped, insert, insertRepetition, insertRepetition, isGroup, isRepeating, isRequired, removeRepetition, tryToInstantiateStructure

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, isGroup, isRepeating, isRequired

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

getName

Constructor Detail

STC_S33

public STC_S33()

Creates a new STC_S33 message with DefaultModelClassFactory.

STC_S33

public STC_S33(ModelClassFactory factory)

Creates a new STC_S33 message with custom ModelClassFactory.

Method Detail

getVersion

public String getVersion()

Returns "2.6"

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

getSCP

public SCP getSCP()

Returns the first repetition of SCP (Sterilizer Configuration Segment) - creates it if necessary

getSCP

public SCP getSCP(int rep)

Returns a specific repetition of SCP (Sterilizer Configuration 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.

getSCPReps

public int getSCPReps()

Returns the number of existing repetitions of SCP

getSCPAll

public List<SCP> getSCPAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertSCP

public void insertSCP(SCP structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of SCP (Sterilizer Configuration Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSCP

public SCP insertSCP(int rep)
              throws HL7Exception

Inserts a specific repetition of SCP (Sterilizer Configuration Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSCP

public SCP removeSCP(int rep)
              throws HL7Exception

Removes a specific repetition of SCP (Sterilizer Configuration Segment)

Throws:

HL7Exception

See Also:

AbstractGroup#removeRepetition(String, int)