ca.uhn.hl7v2.model.v23.group

Class SQR_S25_SCHEDULE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v23.group.SQR_S25_SCHEDULE

All Implemented Interfaces:

Group, Structure, Visitable, Serializable

public class SQR_S25_SCHEDULE
extends AbstractGroup

Represents a SQR_S25_SCHEDULE 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 (Schedule Activity Information)
• 2: NTE (Notes and comments segment) optional repeating
• 3: SQR_S25_PATIENT (a Group object) optional
• 4: SQR_S25_RESOURCES (a Group object) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
SQR_S25_SCHEDULE(Group parent, ModelClassFactory factory) Creates a new SQR_S25_SCHEDULE group

Method Summary

Modifier and Type	Method and Description
NTE	getNTE() Returns the first repetition of NTE (Notes and comments segment) - creates it if necessary
NTE	getNTE(int rep) Returns a specific repetition of NTE (Notes and comments segment) - creates it if necessary
List<NTE>	getNTEAll() Returns a non-modifiable List containing all current existing repetitions of NTE.
int	getNTEReps() Returns the number of existing repetitions of NTE
SQR_S25_PATIENT	getPATIENT() Returns PATIENT (a Group object) - creates it if necessary
SQR_S25_RESOURCES	getRESOURCES() Returns the first repetition of RESOURCES (a Group object) - creates it if necessary
SQR_S25_RESOURCES	getRESOURCES(int rep) Returns a specific repetition of RESOURCES (a Group object) - creates it if necessary
List<SQR_S25_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 (Schedule Activity Information) - creates it if necessary
String	getVersion() Returns "2.3"
NTE	insertNTE(int rep) Inserts a specific repetition of NTE (Notes and comments segment)
void	insertNTE(NTE structure, int rep) Inserts a specific repetition of NTE (Notes and comments segment)
SQR_S25_RESOURCES	insertRESOURCES(int rep) Inserts a specific repetition of RESOURCES (a Group object)
void	insertRESOURCES(SQR_S25_RESOURCES structure, int rep) Inserts a specific repetition of RESOURCES (a Group object)
NTE	removeNTE(int rep) Removes a specific repetition of NTE (Notes and comments segment)
SQR_S25_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

SQR_S25_SCHEDULE

public SQR_S25_SCHEDULE(Group parent,
                        ModelClassFactory factory)

Creates a new SQR_S25_SCHEDULE group

Method Detail

getVersion

public String getVersion()

Returns "2.3"

getSCH

public SCH getSCH()

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

getNTE

public NTE getNTE()

Returns the first repetition of NTE (Notes and comments segment) - creates it if necessary

getNTE

public NTE getNTE(int rep)

Returns a specific repetition of NTE (Notes and comments 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.

getNTEReps

public int getNTEReps()

Returns the number of existing repetitions of NTE

getNTEAll

public List<NTE> getNTEAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertNTE

public void insertNTE(NTE structure,
                      int rep)
               throws HL7Exception

Inserts a specific repetition of NTE (Notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertNTE

public NTE insertNTE(int rep)
              throws HL7Exception

Inserts a specific repetition of NTE (Notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeNTE

public NTE removeNTE(int rep)
              throws HL7Exception

Removes a specific repetition of NTE (Notes and comments segment)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getPATIENT

public SQR_S25_PATIENT getPATIENT()

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

getRESOURCES

public SQR_S25_RESOURCES getRESOURCES()

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

getRESOURCES

public SQR_S25_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<SQR_S25_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(SQR_S25_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 SQR_S25_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 SQR_S25_RESOURCES removeRESOURCES(int rep)
                                  throws HL7Exception

Removes a specific repetition of RESOURCES (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)