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

Class ORL_O22_GENERAL_ORDER

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.ORL_O22_GENERAL_ORDER

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class ORL_O22_GENERAL_ORDER
extends AbstractGroup

Represents a ORL_O22_GENERAL_ORDER 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: ORL_O22_CONTAINER (a Group object) optional
• 2: ORL_O22_ORDER (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	Description
ORL_O22_GENERAL_ORDER(Group parent, ModelClassFactory factory)	Creates a new ORL_O22_GENERAL_ORDER group

Method Summary

Modifier and Type	Method	Description
ORL_O22_CONTAINER	getCONTAINER()	Returns CONTAINER (a Group object) - creates it if necessary
ORL_O22_ORDER	getORDER()	Returns the first repetition of ORDER (a Group object) - creates it if necessary
ORL_O22_ORDER	getORDER(int rep)	Returns a specific repetition of ORDER (a Group object) - creates it if necessary
List<ORL_O22_ORDER>	getORDERAll()	Returns a non-modifiable List containing all current existing repetitions of ORDER.
int	getORDERReps()	Returns the number of existing repetitions of ORDER
String	getVersion()	Returns "2.4"
ORL_O22_ORDER	insertORDER(int rep)	Inserts a specific repetition of ORDER (a Group object)
void	insertORDER(ORL_O22_ORDER structure, int rep)	Inserts a specific repetition of ORDER (a Group object)
ORL_O22_ORDER	removeORDER(int rep)	Removes a specific repetition of ORDER (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 Details

ORL_O22_GENERAL_ORDER

public ORL_O22_GENERAL_ORDER(Group parent,
 ModelClassFactory factory)

Creates a new ORL_O22_GENERAL_ORDER group

Method Details

getVersion

public String getVersion()

Returns "2.4"

getCONTAINER

public ORL_O22_CONTAINER getCONTAINER()

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

getORDER

public ORL_O22_ORDER getORDER()

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

getORDER

public ORL_O22_ORDER getORDER(int rep)

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

getORDERReps

public int getORDERReps()

Returns the number of existing repetitions of ORDER

getORDERAll

public List<ORL_O22_ORDER> getORDERAll()
                                throws HL7Exception

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

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

Throws:

HL7Exception

insertORDER

public void insertORDER(ORL_O22_ORDER structure,
 int rep)
                 throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

insertORDER

public ORL_O22_ORDER insertORDER(int rep)
                          throws HL7Exception

Inserts a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup#insertRepetition(Structure, int)

removeORDER

public ORL_O22_ORDER removeORDER(int rep)
                          throws HL7Exception

Removes a specific repetition of ORDER (a Group object)

Throws:

HL7Exception

See Also:

• AbstractGroup.removeRepetition(String, int)