ca.uhn.fhir.model.dstu.composite

Class PeriodDt

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu.composite.PeriodDt

All Implemented Interfaces:

ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, ISupportsUndeclaredExtensions

public class PeriodDt
extends BaseIdentifiableElement
implements ICompositeDatatype

HAPI/FHIR PeriodDt Datatype (Time range defined by start and end date/time)

Definition: A time period defined by a start and end date and optionally time.

Requirements:

Constructor Summary

Constructors

Constructor and Description
PeriodDt() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
DateTimeDt	getEnd() Gets the value(s) for end (End time with inclusive boundary, if not ongoing).
DateTimeDt	getStart() Gets the value(s) for start (Starting time with inclusive boundary).
boolean	isEmpty()
PeriodDt	setEnd(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for end (End time with inclusive boundary, if not ongoing)
PeriodDt	setEnd(DateTimeDt theValue) Sets the value(s) for end (End time with inclusive boundary, if not ongoing)
PeriodDt	setEndWithSecondsPrecision(Date theDate) Sets the value for end (End time with inclusive boundary, if not ongoing)
PeriodDt	setStart(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for start (Starting time with inclusive boundary)
PeriodDt	setStart(DateTimeDt theValue) Sets the value(s) for start (Starting time with inclusive boundary)
PeriodDt	setStartWithSecondsPrecision(Date theDate) Sets the value for start (Starting time with inclusive boundary)

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

PeriodDt

public PeriodDt()

Constructor

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getStart

public DateTimeDt getStart()

Gets the value(s) for start (Starting time with inclusive boundary). creating it if it does not exist. Will not return null.

Definition: The start of the period. The boundary is inclusive.

setStart

public PeriodDt setStart(DateTimeDt theValue)

Sets the value(s) for start (Starting time with inclusive boundary)

Definition: The start of the period. The boundary is inclusive.

setStartWithSecondsPrecision

public PeriodDt setStartWithSecondsPrecision(Date theDate)

Sets the value for start (Starting time with inclusive boundary)

Definition: The start of the period. The boundary is inclusive.

setStart

public PeriodDt setStart(Date theDate,
                TemporalPrecisionEnum thePrecision)

Sets the value for start (Starting time with inclusive boundary)

Definition: The start of the period. The boundary is inclusive.

getEnd

public DateTimeDt getEnd()

Gets the value(s) for end (End time with inclusive boundary, if not ongoing). creating it if it does not exist. Will not return null.

Definition: The end of the period. If the end of the period is missing, it means that the period is ongoing

setEnd

public PeriodDt setEnd(DateTimeDt theValue)

Sets the value(s) for end (End time with inclusive boundary, if not ongoing)

Definition: The end of the period. If the end of the period is missing, it means that the period is ongoing

setEndWithSecondsPrecision

public PeriodDt setEndWithSecondsPrecision(Date theDate)

Sets the value for end (End time with inclusive boundary, if not ongoing)

Definition: The end of the period. If the end of the period is missing, it means that the period is ongoing

setEnd

public PeriodDt setEnd(Date theDate,
              TemporalPrecisionEnum thePrecision)

Sets the value for end (End time with inclusive boundary, if not ongoing)

Definition: The end of the period. If the end of the period is missing, it means that the period is ongoing