ca.uhn.hl7v2.model.v26.group

Class CSU_C09_STUDY_SCHEDULE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v26.group.CSU_C09_STUDY_SCHEDULE

All Implemented Interfaces:

Group, Structure, Serializable

public class CSU_C09_STUDY_SCHEDULE
extends AbstractGroup

Represents a CSU_C09_STUDY_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: CSS (Clinical Study Data Schedule Segment) optional
• 2: CSU_C09_STUDY_OBSERVATION (a Group object) repeating
• 3: CSU_C09_STUDY_PHARM (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
CSU_C09_STUDY_SCHEDULE(Group parent, ModelClassFactory factory) Creates a new CSU_C09_STUDY_SCHEDULE group

Method Summary

Methods

Modifier and Type	Method and Description
CSS	getCSS() Returns CSS (Clinical Study Data Schedule Segment) - creates it if necessary
CSU_C09_STUDY_OBSERVATION	getSTUDY_OBSERVATION() Returns the first repetition of STUDY_OBSERVATION (a Group object) - creates it if necessary
CSU_C09_STUDY_OBSERVATION	getSTUDY_OBSERVATION(int rep) Returns a specific repetition of STUDY_OBSERVATION (a Group object) - creates it if necessary
List<CSU_C09_STUDY_OBSERVATION>	getSTUDY_OBSERVATIONAll() Returns a non-modifiable List containing all current existing repetitions of STUDY_OBSERVATION.
int	getSTUDY_OBSERVATIONReps() Returns the number of existing repetitions of STUDY_OBSERVATION
CSU_C09_STUDY_PHARM	getSTUDY_PHARM() Returns the first repetition of STUDY_PHARM (a Group object) - creates it if necessary
CSU_C09_STUDY_PHARM	getSTUDY_PHARM(int rep) Returns a specific repetition of STUDY_PHARM (a Group object) - creates it if necessary
List<CSU_C09_STUDY_PHARM>	getSTUDY_PHARMAll() Returns a non-modifiable List containing all current existing repetitions of STUDY_PHARM.
int	getSTUDY_PHARMReps() Returns the number of existing repetitions of STUDY_PHARM
String	getVersion() Returns "2.6"
void	insertSTUDY_OBSERVATION(CSU_C09_STUDY_OBSERVATION structure, int rep) Inserts a specific repetition of STUDY_OBSERVATION (a Group object)
CSU_C09_STUDY_OBSERVATION	insertSTUDY_OBSERVATION(int rep) Inserts a specific repetition of STUDY_OBSERVATION (a Group object)
void	insertSTUDY_PHARM(CSU_C09_STUDY_PHARM structure, int rep) Inserts a specific repetition of STUDY_PHARM (a Group object)
CSU_C09_STUDY_PHARM	insertSTUDY_PHARM(int rep) Inserts a specific repetition of STUDY_PHARM (a Group object)
CSU_C09_STUDY_OBSERVATION	removeSTUDY_OBSERVATION(int rep) Removes a specific repetition of STUDY_OBSERVATION (a Group object)
CSU_C09_STUDY_PHARM	removeSTUDY_PHARM(int rep) Removes a specific repetition of STUDY_PHARM (a Group object)

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 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

CSU_C09_STUDY_SCHEDULE

public CSU_C09_STUDY_SCHEDULE(Group parent,
                      ModelClassFactory factory)

Creates a new CSU_C09_STUDY_SCHEDULE group

Method Detail

getVersion

public String getVersion()

Returns "2.6"

getCSS

public CSS getCSS()

Returns CSS (Clinical Study Data Schedule Segment) - creates it if necessary

getSTUDY_OBSERVATION

public CSU_C09_STUDY_OBSERVATION getSTUDY_OBSERVATION()

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

getSTUDY_OBSERVATION

public CSU_C09_STUDY_OBSERVATION getSTUDY_OBSERVATION(int rep)

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

getSTUDY_OBSERVATIONReps

public int getSTUDY_OBSERVATIONReps()

Returns the number of existing repetitions of STUDY_OBSERVATION

getSTUDY_OBSERVATIONAll

public List<CSU_C09_STUDY_OBSERVATION> getSTUDY_OBSERVATIONAll()
                                                        throws HL7Exception

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

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

Throws:

HL7Exception

insertSTUDY_OBSERVATION

public void insertSTUDY_OBSERVATION(CSU_C09_STUDY_OBSERVATION structure,
                           int rep)
                             throws HL7Exception

Inserts a specific repetition of STUDY_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSTUDY_OBSERVATION

public CSU_C09_STUDY_OBSERVATION insertSTUDY_OBSERVATION(int rep)
                                                  throws HL7Exception

Inserts a specific repetition of STUDY_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSTUDY_OBSERVATION

public CSU_C09_STUDY_OBSERVATION removeSTUDY_OBSERVATION(int rep)
                                                  throws HL7Exception

Removes a specific repetition of STUDY_OBSERVATION (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getSTUDY_PHARM

public CSU_C09_STUDY_PHARM getSTUDY_PHARM()

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

getSTUDY_PHARM

public CSU_C09_STUDY_PHARM getSTUDY_PHARM(int rep)

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

getSTUDY_PHARMReps

public int getSTUDY_PHARMReps()

Returns the number of existing repetitions of STUDY_PHARM

getSTUDY_PHARMAll

public List<CSU_C09_STUDY_PHARM> getSTUDY_PHARMAll()
                                            throws HL7Exception

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

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

Throws:

HL7Exception

insertSTUDY_PHARM

public void insertSTUDY_PHARM(CSU_C09_STUDY_PHARM structure,
                     int rep)
                       throws HL7Exception

Inserts a specific repetition of STUDY_PHARM (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSTUDY_PHARM

public CSU_C09_STUDY_PHARM insertSTUDY_PHARM(int rep)
                                      throws HL7Exception

Inserts a specific repetition of STUDY_PHARM (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSTUDY_PHARM

public CSU_C09_STUDY_PHARM removeSTUDY_PHARM(int rep)
                                      throws HL7Exception

Removes a specific repetition of STUDY_PHARM (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)