ca.uhn.hl7v2.model.v231.group

Class ORD_O02_PIDNTEORCODSNTEORCODTNTE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v231.group.ORD_O02_PIDNTEORCODSNTEORCODTNTE

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORD_O02_PIDNTEORCODSNTEORCODTNTE
extends AbstractGroup

Represents a ORD_O02_PIDNTEORCODSNTEORCODTNTE 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: ORD_O02_PIDNTE (a Group object) optional
• 2: ORD_O02_ORCODSNTE (a Group object) repeating
• 3: ORD_O02_ORCODTNTE (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
ORD_O02_PIDNTEORCODSNTEORCODTNTE(Group parent, ModelClassFactory factory) Creates a new ORD_O02_PIDNTEORCODSNTEORCODTNTE group

Method Summary

Modifier and Type	Method and Description
ORD_O02_ORCODSNTE	getORCODSNTE() Returns the first repetition of ORCODSNTE (a Group object) - creates it if necessary
ORD_O02_ORCODSNTE	getORCODSNTE(int rep) Returns a specific repetition of ORCODSNTE (a Group object) - creates it if necessary
List<ORD_O02_ORCODSNTE>	getORCODSNTEAll() Returns a non-modifiable List containing all current existing repetitions of ORCODSNTE.
int	getORCODSNTEReps() Returns the number of existing repetitions of ORCODSNTE
ORD_O02_ORCODTNTE	getORCODTNTE() Returns the first repetition of ORCODTNTE (a Group object) - creates it if necessary
ORD_O02_ORCODTNTE	getORCODTNTE(int rep) Returns a specific repetition of ORCODTNTE (a Group object) - creates it if necessary
List<ORD_O02_ORCODTNTE>	getORCODTNTEAll() Returns a non-modifiable List containing all current existing repetitions of ORCODTNTE.
int	getORCODTNTEReps() Returns the number of existing repetitions of ORCODTNTE
ORD_O02_PIDNTE	getPIDNTE() Returns PIDNTE (a Group object) - creates it if necessary
String	getVersion() Returns "2.3.1"
ORD_O02_ORCODSNTE	insertORCODSNTE(int rep) Inserts a specific repetition of ORCODSNTE (a Group object)
void	insertORCODSNTE(ORD_O02_ORCODSNTE structure, int rep) Inserts a specific repetition of ORCODSNTE (a Group object)
ORD_O02_ORCODTNTE	insertORCODTNTE(int rep) Inserts a specific repetition of ORCODTNTE (a Group object)
void	insertORCODTNTE(ORD_O02_ORCODTNTE structure, int rep) Inserts a specific repetition of ORCODTNTE (a Group object)
ORD_O02_ORCODSNTE	removeORCODSNTE(int rep) Removes a specific repetition of ORCODSNTE (a Group object)
ORD_O02_ORCODTNTE	removeORCODTNTE(int rep) Removes a specific repetition of ORCODTNTE (a Group object)

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

ORD_O02_PIDNTEORCODSNTEORCODTNTE

public ORD_O02_PIDNTEORCODSNTEORCODTNTE(Group parent,
                                        ModelClassFactory factory)

Creates a new ORD_O02_PIDNTEORCODSNTEORCODTNTE group

Method Detail

getVersion

public String getVersion()

Returns "2.3.1"

getPIDNTE

public ORD_O02_PIDNTE getPIDNTE()

Returns PIDNTE (a Group object) - creates it if necessary

getORCODSNTE

public ORD_O02_ORCODSNTE getORCODSNTE()

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

getORCODSNTE

public ORD_O02_ORCODSNTE getORCODSNTE(int rep)

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

getORCODSNTEReps

public int getORCODSNTEReps()

Returns the number of existing repetitions of ORCODSNTE

getORCODSNTEAll

public List<ORD_O02_ORCODSNTE> getORCODSNTEAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertORCODSNTE

public void insertORCODSNTE(ORD_O02_ORCODSNTE structure,
                            int rep)
                     throws HL7Exception

Inserts a specific repetition of ORCODSNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORCODSNTE

public ORD_O02_ORCODSNTE insertORCODSNTE(int rep)
                                  throws HL7Exception

Inserts a specific repetition of ORCODSNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORCODSNTE

public ORD_O02_ORCODSNTE removeORCODSNTE(int rep)
                                  throws HL7Exception

Removes a specific repetition of ORCODSNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getORCODTNTE

public ORD_O02_ORCODTNTE getORCODTNTE()

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

getORCODTNTE

public ORD_O02_ORCODTNTE getORCODTNTE(int rep)

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

getORCODTNTEReps

public int getORCODTNTEReps()

Returns the number of existing repetitions of ORCODTNTE

getORCODTNTEAll

public List<ORD_O02_ORCODTNTE> getORCODTNTEAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertORCODTNTE

public void insertORCODTNTE(ORD_O02_ORCODTNTE structure,
                            int rep)
                     throws HL7Exception

Inserts a specific repetition of ORCODTNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertORCODTNTE

public ORD_O02_ORCODTNTE insertORCODTNTE(int rep)
                                  throws HL7Exception

Inserts a specific repetition of ORCODTNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeORCODTNTE

public ORD_O02_ORCODTNTE removeORCODTNTE(int rep)
                                  throws HL7Exception

Removes a specific repetition of ORCODTNTE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)