org.hl7.fhir.dstu3.model

Class Period

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.Element

org.hl7.fhir.dstu3.model.Type

org.hl7.fhir.dstu3.model.Period

All Implemented Interfaces:

IElement, Serializable, IBase, IBaseDatatype, IBaseElement, IBaseHasExtensions, ICompositeType

public class Period
extends Type
implements ICompositeType

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected DateTimeType	end The end of the period.
protected DateTimeType	start The start of the period.

Fields inherited from class org.hl7.fhir.dstu3.model.Element

extension, id

Constructor Summary

Constructors

Constructor and Description
Period() Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
Period	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Date	getEnd()
DateTimeType	getEndElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
Date	getStart()
DateTimeType	getStartElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasEnd()
boolean	hasEndElement()
boolean	hasStart()
boolean	hasStartElement()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Base	makeProperty(int hash, String name)
Period	setEnd(Date value)
Period	setEnd(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for end ()
Period	setEndElement(DateTimeType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Period	setStart(Date value)
Period	setStart(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for start ()
Period	setStartElement(DateTimeType value)
protected Period	typedCopy()

Methods inherited from class org.hl7.fhir.dstu3.model.Element

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.dstu3.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Field Detail

start

protected DateTimeType start

The start of the period. The boundary is inclusive.

end

protected DateTimeType end

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Constructor Detail

Period

public Period()

Constructor

Method Detail

getStartElement

public DateTimeType getStartElement()

Returns:

start (The start of the period. The boundary is inclusive.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value

hasStartElement

public boolean hasStartElement()

hasStart

public boolean hasStart()

setStartElement

public Period setStartElement(DateTimeType value)

Parameters:

value - start (The start of the period. The boundary is inclusive.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value

getStart

public Date getStart()

Returns:

The start of the period. The boundary is inclusive.

setStart

public Period setStart(Date value)

Parameters:

value - The start of the period. The boundary is inclusive.

getEndElement

public DateTimeType getEndElement()

Returns:

end (The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

hasEndElement

public boolean hasEndElement()

hasEnd

public boolean hasEnd()

setEndElement

public Period setEndElement(DateTimeType value)

Parameters:

value - end (The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

getEnd

public Date getEnd()

Returns:

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

setEnd

public Period setEnd(Date value)

Parameters:

value - The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

setStart

public Period setStart(Date theDate,
                       TemporalPrecisionEnum thePrecision)

Sets the value for start ()

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

setEnd

public Period setEnd(Date theDate,
                     TemporalPrecisionEnum thePrecision)

Sets the value for end ()

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

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class Element

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException

Overrides:

getProperty in class Element

Throws:

FHIRException

setProperty

public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException

Overrides:

setProperty in class Element

Throws:

FHIRException

setProperty

public Base setProperty(String name,
                        Base value)
                 throws FHIRException

Overrides:

setProperty in class Element

Throws:

FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws FHIRException

Overrides:

makeProperty in class Element

Throws:

FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException

Overrides:

getTypesForProperty in class Element

Throws:

FHIRException

addChild

public Base addChild(String name)
              throws FHIRException

Overrides:

addChild in class Element

Throws:

FHIRException

fhirType

public String fhirType()

Overrides:

fhirType in class Element

copy

public Period copy()

Overrides:

copy in class Type

typedCopy

protected Period typedCopy()

Specified by:

typedCopy in class Type

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class Element

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class Element

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

Overrides:

isEmpty in class Element