ca.uhn.hl7v2.model.v23.segment

Class CM2

java.lang.Object

ca.uhn.hl7v2.model.AbstractStructure

ca.uhn.hl7v2.model.AbstractSegment

ca.uhn.hl7v2.model.v23.segment.CM2

All Implemented Interfaces:

Segment, Structure, Serializable

public class CM2
extends AbstractSegment

Represents an HL7 CM2 message segment (Clinical Study Schedule Master). This segment has the following fields:

• CM2-1: CM2 - Set ID (SI) optional
• CM2-2: Scheduled Time Point (CE)
• CM2-3: Description of Time Point (ST) optional
• CM2-4: Events Scheduled This Time Point (CE) repeating

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
CM2(Group parent, ModelClassFactory factory) Creates a new CM2 segment

Method Summary

Methods

Modifier and Type	Method and Description
protected Type	createNewTypeWithoutReflection(int field)
SI	getCm21_CM2SetID() Returns CM2-1: "CM2 - Set ID" - creates it if necessary
CE	getCm22_ScheduledTimePoint() Returns CM2-2: "Scheduled Time Point" - creates it if necessary
ST	getCm23_DescriptionOfTimePoint() Returns CM2-3: "Description of Time Point" - creates it if necessary
CE[]	getCm24_EventsScheduledThisTimePoint() Returns all repetitions of Events Scheduled This Time Point (CM2-4).
CE	getCm24_EventsScheduledThisTimePoint(int rep) Returns a specific repetition of CM2-4: "Events Scheduled This Time Point" - creates it if necessary
int	getCm24_EventsScheduledThisTimePointReps() Returns a count of the current number of repetitions of Events Scheduled This Time Point (CM2-4).
SI	getCM2SetID() Returns CM2-1: "CM2 - Set ID" - creates it if necessary
ST	getDescriptionOfTimePoint() Returns CM2-3: "Description of Time Point" - creates it if necessary
CE[]	getEventsScheduledThisTimePoint() Returns all repetitions of Events Scheduled This Time Point (CM2-4).
CE	getEventsScheduledThisTimePoint(int rep) Returns a specific repetition of CM2-4: "Events Scheduled This Time Point" - creates it if necessary
int	getEventsScheduledThisTimePointReps() Returns a count of the current number of repetitions of Events Scheduled This Time Point (CM2-4).
CE	getScheduledTimePoint() Returns CM2-2: "Scheduled Time Point" - creates it if necessary
CE	insertCm24_EventsScheduledThisTimePoint(int rep) Inserts a repetition of CM2-4: "Events Scheduled This Time Point" at a specific index
CE	insertEventsScheduledThisTimePoint(int rep) Inserts a repetition of CM2-4: "Events Scheduled This Time Point" at a specific index
CE	removeCm24_EventsScheduledThisTimePoint(int rep) Removes a repetition of CM2-4: "Events Scheduled This Time Point" at a specific index
CE	removeEventsScheduledThisTimePoint(int rep) Removes a repetition of CM2-4: "Events Scheduled This Time Point" at a specific index

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

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getName, getNames, getReps, getTypedField, getTypedField, insertRepetition, isRequired, main, numFields, parse, removeRepetition

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

CM2

public CM2(Group parent,
   ModelClassFactory factory)

Creates a new CM2 segment

Method Detail

getCM2SetID

public SI getCM2SetID()

Returns CM2-1: "CM2 - Set ID" - creates it if necessary

getCm21_CM2SetID

public SI getCm21_CM2SetID()

Returns CM2-1: "CM2 - Set ID" - creates it if necessary

getScheduledTimePoint

public CE getScheduledTimePoint()

Returns CM2-2: "Scheduled Time Point" - creates it if necessary

getCm22_ScheduledTimePoint

public CE getCm22_ScheduledTimePoint()

Returns CM2-2: "Scheduled Time Point" - creates it if necessary

getDescriptionOfTimePoint

public ST getDescriptionOfTimePoint()

Returns CM2-3: "Description of Time Point" - creates it if necessary

getCm23_DescriptionOfTimePoint

public ST getCm23_DescriptionOfTimePoint()

Returns CM2-3: "Description of Time Point" - creates it if necessary

getEventsScheduledThisTimePoint

public CE[] getEventsScheduledThisTimePoint()

Returns all repetitions of Events Scheduled This Time Point (CM2-4).

getCm24_EventsScheduledThisTimePoint

public CE[] getCm24_EventsScheduledThisTimePoint()

Returns all repetitions of Events Scheduled This Time Point (CM2-4).

getEventsScheduledThisTimePointReps

public int getEventsScheduledThisTimePointReps()

Returns a count of the current number of repetitions of Events Scheduled This Time Point (CM2-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getEventsScheduledThisTimePoint

public CE getEventsScheduledThisTimePoint(int rep)

Returns a specific repetition of CM2-4: "Events Scheduled This Time Point" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCm24_EventsScheduledThisTimePoint

public CE getCm24_EventsScheduledThisTimePoint(int rep)

Returns a specific repetition of CM2-4: "Events Scheduled This Time Point" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCm24_EventsScheduledThisTimePointReps

public int getCm24_EventsScheduledThisTimePointReps()

Returns a count of the current number of repetitions of Events Scheduled This Time Point (CM2-4). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertEventsScheduledThisTimePoint

public CE insertEventsScheduledThisTimePoint(int rep)
                                      throws HL7Exception

Inserts a repetition of CM2-4: "Events Scheduled This Time Point" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

insertCm24_EventsScheduledThisTimePoint

public CE insertCm24_EventsScheduledThisTimePoint(int rep)
                                           throws HL7Exception

Inserts a repetition of CM2-4: "Events Scheduled This Time Point" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeEventsScheduledThisTimePoint

public CE removeEventsScheduledThisTimePoint(int rep)
                                      throws HL7Exception

Removes a repetition of CM2-4: "Events Scheduled This Time Point" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

removeCm24_EventsScheduledThisTimePoint

public CE removeCm24_EventsScheduledThisTimePoint(int rep)
                                           throws HL7Exception

Removes a repetition of CM2-4: "Events Scheduled This Time Point" at a specific index

Parameters:

rep - The repetition index (0-indexed)

Throws:

HL7Exception - If the rep is invalid (below 0, or too high for the allowable repetitions)

createNewTypeWithoutReflection

protected Type createNewTypeWithoutReflection(int field)

Overrides:

createNewTypeWithoutReflection in class AbstractSegment