ca.uhn.hl7v2.model.v24.datatype

Class OSP

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v24.datatype.OSP

All Implemented Interfaces:

Composite, Type, Serializable

public class OSP
extends AbstractComposite

Represents an HL7 OSP (occurence span) data type. This type consists of the following components:

• occurrence span code (CE)
• occurrence span start date (DT)
• occurrence span stop date (DT)

See Also:

Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
OSP(Message message) Creates a new OSP type

Method Summary

Methods

Modifier and Type	Method and Description
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
CE	getOccurrenceSpanCode() Returns occurrence span code (component 1).
DT	getOccurrenceSpanStartDate() Returns occurrence span start date (component 2).
DT	getOccurrenceSpanStopDate() Returns occurrence span stop date (component 3).
CE	getOsp1_OccurrenceSpanCode() Returns occurrence span code (component 1).
DT	getOsp2_OccurrenceSpanStartDate() Returns occurrence span start date (component 2).
DT	getOsp3_OccurrenceSpanStopDate() Returns occurrence span stop date (component 3).

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

clear, getTyped, isEmpty

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

encode, getExtraComponents, getMessage, getName, parse, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.model.Type

encode, getExtraComponents, getMessage, getName, parse

Constructor Detail

OSP

public OSP(Message message)

Creates a new OSP type

Method Detail

getComponents

public Type[] getComponents()

Returns an array containing the data elements.

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

Parameters:

number - The component number (0-indexed)

Throws:

DataTypeException - if the given element number is out of range.

getOccurrenceSpanCode

public CE getOccurrenceSpanCode()

Returns occurrence span code (component 1). This is a convenience method that saves you from casting and handling an exception.

getOsp1_OccurrenceSpanCode

public CE getOsp1_OccurrenceSpanCode()

Returns occurrence span code (component 1). This is a convenience method that saves you from casting and handling an exception.

getOccurrenceSpanStartDate

public DT getOccurrenceSpanStartDate()

Returns occurrence span start date (component 2). This is a convenience method that saves you from casting and handling an exception.

getOsp2_OccurrenceSpanStartDate

public DT getOsp2_OccurrenceSpanStartDate()

Returns occurrence span start date (component 2). This is a convenience method that saves you from casting and handling an exception.

getOccurrenceSpanStopDate

public DT getOccurrenceSpanStopDate()

Returns occurrence span stop date (component 3). This is a convenience method that saves you from casting and handling an exception.

getOsp3_OccurrenceSpanStopDate

public DT getOsp3_OccurrenceSpanStopDate()

Returns occurrence span stop date (component 3). This is a convenience method that saves you from casting and handling an exception.