Package ca.uhn.hl7v2.model.v251.datatype

Class OSP

java.lang.Object

ca.uhn.hl7v2.model.AbstractType

ca.uhn.hl7v2.model.AbstractComposite

ca.uhn.hl7v2.model.v251.datatype.OSP

All Implemented Interfaces:

Composite, Type, Visitable, Serializable

public class OSP
extends AbstractComposite

Represents an HL7 OSP (Occurrence Span Code and Date) data type. This type consists of the following components:

• Occurrence Span Code (CNE)
• Occurrence Span Start Date (DT)
• Occurrence Span Stop Date (DT)

See Also:

• Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Type	getComponent(int number)	Returns an individual data component.
Type[]	getComponents()	Returns an array containing the data elements.
CNE	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).
CNE	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

accept, clear, getTyped, isEmpty, provideLocation

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 Details

OSP

public OSP(Message message)

Creates a new OSP type

Method Details

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 CNE getOccurrenceSpanCode()

Returns Occurrence Span Code (component 1). This is a convenience method that saves you from casting and handling an exception.

getOsp1_OccurrenceSpanCode

public CNE 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.