ca.uhn.hl7v2.model.v24.segment
Class CSS

java.lang.Object
  ca.uhn.hl7v2.model.AbstractSegment
      ca.uhn.hl7v2.model.v24.segment.CSS

All Implemented Interfaces:

Segment, Structure, Serializable

public class CSS
extends AbstractSegment

Represents an HL7 CSS message segment (Clinical Study Data Schedule Segment). This segment has the following fields:

• CSS-1: Study Scheduled Time Point (CE)
• CSS-2: Study Scheduled Patient Time Point (TS) optional
• CSS-3: Study Quality Control Codes (CE) optional repeating

See Also:

Serialized Form

Constructor Summary

CSS(Group parent, ModelClassFactory factory)
Creates a new CSS segment

Method Summary

protected Type	createNewTypeWithoutReflection(int field)
CE	getCss1_StudyScheduledTimePoint() Returns CSS-1: "Study Scheduled Time Point" - creates it if necessary
TS	getCss2_StudyScheduledPatientTimePoint() Returns CSS-2: "Study Scheduled Patient Time Point" - creates it if necessary
CE	getCss3_StudyQualityControlCodes(int rep) Returns a specific repetition of CSS-3: "Study Quality Control Codes" - creates it if necessary
int	getCss3_StudyQualityControlCodesReps() Returns a count of the current number of repetitions of Study Quality Control Codes (CSS-3).
CE[]	getStudyQualityControlCodes() Returns all repetitions of Study Quality Control Codes (CSS-3).
CE	getStudyQualityControlCodes(int rep) Returns a specific repetition of CSS-3: "Study Quality Control Codes" - creates it if necessary
int	getStudyQualityControlCodesReps() Returns a count of the current number of repetitions of Study Quality Control Codes (CSS-3).
TS	getStudyScheduledPatientTimePoint() Returns CSS-2: "Study Scheduled Patient Time Point" - creates it if necessary
CE	getStudyScheduledTimePoint() Returns CSS-1: "Study Scheduled Time Point" - creates it if necessary
CE	insertCss3_StudyQualityControlCodes(int rep) Inserts a repetition of CSS-3: "Study Quality Control Codes" at a specific index
CE	insertStudyQualityControlCodes(int rep) Inserts a repetition of CSS-3: "Study Quality Control Codes" at a specific index
CE	removeCss3_StudyQualityControlCodes(int rep) Removes a repetition of CSS-3: "Study Quality Control Codes" at a specific index
CE	removeStudyQualityControlCodes(int rep) Removes a repetition of CSS-3: "Study Quality Control Codes" at a specific index

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

add, add, clear, encode, getField, getField, getLength, getMaxCardinality, getMessage, getName, getNames, getParent, insertRepetition, isRequired, main, numFields, parse, removeRepetition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CSS

public CSS(Group parent,
           ModelClassFactory factory)

Creates a new CSS segment

Method Detail

getStudyScheduledTimePoint

public CE getStudyScheduledTimePoint()

Returns CSS-1: "Study Scheduled Time Point" - creates it if necessary

getCss1_StudyScheduledTimePoint

public CE getCss1_StudyScheduledTimePoint()

Returns CSS-1: "Study Scheduled Time Point" - creates it if necessary

getStudyScheduledPatientTimePoint

public TS getStudyScheduledPatientTimePoint()

Returns CSS-2: "Study Scheduled Patient Time Point" - creates it if necessary

getCss2_StudyScheduledPatientTimePoint

public TS getCss2_StudyScheduledPatientTimePoint()

Returns CSS-2: "Study Scheduled Patient Time Point" - creates it if necessary

getStudyQualityControlCodes

public CE[] getStudyQualityControlCodes()

Returns all repetitions of Study Quality Control Codes (CSS-3).

getStudyQualityControlCodesReps

public int getStudyQualityControlCodesReps()

Returns a count of the current number of repetitions of Study Quality Control Codes (CSS-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

getStudyQualityControlCodes

public CE getStudyQualityControlCodes(int rep)

Returns a specific repetition of CSS-3: "Study Quality Control Codes" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCss3_StudyQualityControlCodes

public CE getCss3_StudyQualityControlCodes(int rep)

Returns a specific repetition of CSS-3: "Study Quality Control Codes" - creates it if necessary

Parameters:

rep - The repetition index (0-indexed)

getCss3_StudyQualityControlCodesReps

public int getCss3_StudyQualityControlCodesReps()

Returns a count of the current number of repetitions of Study Quality Control Codes (CSS-3). This method does not create a repetition, so if no repetitions have currently been defined or accessed, it will return zero.

insertStudyQualityControlCodes

public CE insertStudyQualityControlCodes(int rep)
                                  throws HL7Exception

Inserts a repetition of CSS-3: "Study Quality Control Codes" 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)

insertCss3_StudyQualityControlCodes

public CE insertCss3_StudyQualityControlCodes(int rep)
                                       throws HL7Exception

Inserts a repetition of CSS-3: "Study Quality Control Codes" 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)

removeStudyQualityControlCodes

public CE removeStudyQualityControlCodes(int rep)
                                  throws HL7Exception

Removes a repetition of CSS-3: "Study Quality Control Codes" 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)

removeCss3_StudyQualityControlCodes

public CE removeCss3_StudyQualityControlCodes(int rep)
                                       throws HL7Exception

Removes a repetition of CSS-3: "Study Quality Control Codes" 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