ca.uhn.hl7v2.model.v24.group

Class CSU_C09_STUDY_PHASE

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractGroup

ca.uhn.hl7v2.model.v24.group.CSU_C09_STUDY_PHASE

All Implemented Interfaces:

Group, Structure, Serializable

public class CSU_C09_STUDY_PHASE
extends AbstractGroup

Represents a CSU_C09_STUDY_PHASE 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: CSP (Clinical Study Phase) optional repeating
• 2: CSU_C09_STUDY_SCHEDULE (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_PHASE(Group parent, ModelClassFactory factory) Creates a new CSU_C09_STUDY_PHASE group

Method Summary

Methods

Modifier and Type	Method and Description
CSP	getCSP() Returns the first repetition of CSP (Clinical Study Phase) - creates it if necessary
CSP	getCSP(int rep) Returns a specific repetition of CSP (Clinical Study Phase) - creates it if necessary
List<CSP>	getCSPAll() Returns a non-modifiable List containing all current existing repetitions of CSP.
int	getCSPReps() Returns the number of existing repetitions of CSP
CSU_C09_STUDY_SCHEDULE	getSTUDY_SCHEDULE() Returns the first repetition of STUDY_SCHEDULE (a Group object) - creates it if necessary
CSU_C09_STUDY_SCHEDULE	getSTUDY_SCHEDULE(int rep) Returns a specific repetition of STUDY_SCHEDULE (a Group object) - creates it if necessary
List<CSU_C09_STUDY_SCHEDULE>	getSTUDY_SCHEDULEAll() Returns a non-modifiable List containing all current existing repetitions of STUDY_SCHEDULE.
int	getSTUDY_SCHEDULEReps() Returns the number of existing repetitions of STUDY_SCHEDULE
String	getVersion() Returns "2.4"
void	insertCSP(CSP structure, int rep) Inserts a specific repetition of CSP (Clinical Study Phase)
CSP	insertCSP(int rep) Inserts a specific repetition of CSP (Clinical Study Phase)
void	insertSTUDY_SCHEDULE(CSU_C09_STUDY_SCHEDULE structure, int rep) Inserts a specific repetition of STUDY_SCHEDULE (a Group object)
CSU_C09_STUDY_SCHEDULE	insertSTUDY_SCHEDULE(int rep) Inserts a specific repetition of STUDY_SCHEDULE (a Group object)
CSP	removeCSP(int rep) Removes a specific repetition of CSP (Clinical Study Phase)
CSU_C09_STUDY_SCHEDULE	removeSTUDY_SCHEDULE(int rep) Removes a specific repetition of STUDY_SCHEDULE (a Group object)

Methods inherited from class ca.uhn.hl7v2.model.AbstractGroup

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

public CSU_C09_STUDY_PHASE(Group parent,
                   ModelClassFactory factory)

Creates a new CSU_C09_STUDY_PHASE group

Method Detail

getVersion

public String getVersion()

Returns "2.4"

getCSP

public CSP getCSP()

Returns the first repetition of CSP (Clinical Study Phase) - creates it if necessary

getCSP

public CSP getCSP(int rep)

Returns a specific repetition of CSP (Clinical Study Phase) - 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.

getCSPReps

public int getCSPReps()

Returns the number of existing repetitions of CSP

getCSPAll

public List<CSP> getCSPAll()
                    throws HL7Exception

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

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

Throws:

HL7Exception

insertCSP

public void insertCSP(CSP structure,
             int rep)
               throws HL7Exception

Inserts a specific repetition of CSP (Clinical Study Phase)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertCSP

public CSP insertCSP(int rep)
              throws HL7Exception

Inserts a specific repetition of CSP (Clinical Study Phase)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeCSP

public CSP removeCSP(int rep)
              throws HL7Exception

Removes a specific repetition of CSP (Clinical Study Phase)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)

getSTUDY_SCHEDULE

public CSU_C09_STUDY_SCHEDULE getSTUDY_SCHEDULE()

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

getSTUDY_SCHEDULE

public CSU_C09_STUDY_SCHEDULE getSTUDY_SCHEDULE(int rep)

Returns a specific repetition of STUDY_SCHEDULE (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_SCHEDULEReps

public int getSTUDY_SCHEDULEReps()

Returns the number of existing repetitions of STUDY_SCHEDULE

getSTUDY_SCHEDULEAll

public List<CSU_C09_STUDY_SCHEDULE> getSTUDY_SCHEDULEAll()
                                                  throws HL7Exception

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

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

Throws:

HL7Exception

insertSTUDY_SCHEDULE

public void insertSTUDY_SCHEDULE(CSU_C09_STUDY_SCHEDULE structure,
                        int rep)
                          throws HL7Exception

Inserts a specific repetition of STUDY_SCHEDULE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

insertSTUDY_SCHEDULE

public CSU_C09_STUDY_SCHEDULE insertSTUDY_SCHEDULE(int rep)
                                            throws HL7Exception

Inserts a specific repetition of STUDY_SCHEDULE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup#insertRepetition(Structure, int)

removeSTUDY_SCHEDULE

public CSU_C09_STUDY_SCHEDULE removeSTUDY_SCHEDULE(int rep)
                                            throws HL7Exception

Removes a specific repetition of STUDY_SCHEDULE (a Group object)

Throws:

HL7Exception

See Also:

AbstractGroup.removeRepetition(String, int)