ca.uhn.hl7v2.model.v28.group

Class CCR_I16_APPOINTMENT_HISTORY

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v28.group.CCR_I16_APPOINTMENT_HISTORY

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class CCR_I16_APPOINTMENT_HISTORY
extends AbstractGroup

Represents a CCR_I16_APPOINTMENT_HISTORY 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: SCH (Scheduling Activity Information)
• 2: CCR_I16_RESOURCES (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
CCR_I16_APPOINTMENT_HISTORY(Group parent, ModelClassFactory factory) Creates a new CCR_I16_APPOINTMENT_HISTORY group

Method Summary

Modifier and Type	Method and Description
CCR_I16_RESOURCES	getRESOURCES() Returns the first repetition of RESOURCES (a Group object) - creates it if necessary
CCR_I16_RESOURCES	getRESOURCES(int rep) Returns a specific repetition of RESOURCES (a Group object) - creates it if necessary
List<CCR_I16_RESOURCES>	getRESOURCESAll() Returns a non-modifiable List containing all current existing repetitions of RESOURCES.
int	getRESOURCESReps() Returns the number of existing repetitions of RESOURCES
SCH	getSCH() Returns SCH (Scheduling Activity Information) - creates it if necessary
String	getVersion() Returns "2.8"
void	insertRESOURCES(CCR_I16_RESOURCES structure, int rep) Inserts a specific repetition of RESOURCES (a Group object)
CCR_I16_RESOURCES	insertRESOURCES(int rep) Inserts a specific repetition of RESOURCES (a Group object)
CCR_I16_RESOURCES	removeRESOURCES(int rep) Removes a specific repetition of RESOURCES (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

CCR_I16_APPOINTMENT_HISTORY

public CCR_I16_APPOINTMENT_HISTORY(Group parent,
                                   ModelClassFactory factory)

Creates a new CCR_I16_APPOINTMENT_HISTORY group

Method Detail

getVersion

public String getVersion()

Returns "2.8"

getSCH

public SCH getSCH()

Returns SCH (Scheduling Activity Information) - creates it if necessary

getRESOURCES

public CCR_I16_RESOURCES getRESOURCES()

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

getRESOURCES

public CCR_I16_RESOURCES getRESOURCES(int rep)

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

getRESOURCESReps

public int getRESOURCESReps()

Returns the number of existing repetitions of RESOURCES

getRESOURCESAll

public List<CCR_I16_RESOURCES> getRESOURCESAll()
                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertRESOURCES

public void insertRESOURCES(CCR_I16_RESOURCES structure,
                            int rep)
                     throws HL7Exception

Inserts a specific repetition of RESOURCES (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertRESOURCES

public CCR_I16_RESOURCES insertRESOURCES(int rep)
                                  throws HL7Exception

Inserts a specific repetition of RESOURCES (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeRESOURCES

public CCR_I16_RESOURCES removeRESOURCES(int rep)
                                  throws HL7Exception

Removes a specific repetition of RESOURCES (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)