ca.uhn.fhir.model.dstu.composite

Class ScheduleDt

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu.composite.ScheduleDt

All Implemented Interfaces:

ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, ISupportsUndeclaredExtensions

public class ScheduleDt
extends BaseIdentifiableElement
implements ICompositeDatatype

HAPI/FHIR ScheduleDt Datatype (A schedule that specifies an event that may occur multiple times)

Definition: Specifies an event that may occur multiple times. Schedules are used for to reord when things are expected or requested to occur.

Requirements: Need to able to track schedules. There are several different ways to do scheduling: one or more specified times, a simple rules like three times a day, or before/after meals

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScheduleDt.Repeat Block class for child element: Schedule.repeat (Only if there is none or one event)

Constructor Summary

Constructors

Constructor and Description
ScheduleDt() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
PeriodDt	addEvent() Adds and returns a new value for event (When the event occurs)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
List<PeriodDt>	getEvent() Gets the value(s) for event (When the event occurs).
PeriodDt	getEventFirstRep() Gets the first repetition for event (When the event occurs), creating it if it does not already exist.
ScheduleDt.Repeat	getRepeat() Gets the value(s) for repeat (Only if there is none or one event).
boolean	isEmpty()
ScheduleDt	setEvent(List<PeriodDt> theValue) Sets the value(s) for event (When the event occurs)
ScheduleDt	setRepeat(ScheduleDt.Repeat theValue) Sets the value(s) for repeat (Only if there is none or one event)

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

ScheduleDt

public ScheduleDt()

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

getEvent

public List<PeriodDt> getEvent()

Gets the value(s) for event (When the event occurs). creating it if it does not exist. Will not return null.

Definition: Identifies specific time periods when the event should occur

setEvent

public ScheduleDt setEvent(List<PeriodDt> theValue)

Sets the value(s) for event (When the event occurs)

Definition: Identifies specific time periods when the event should occur

addEvent

public PeriodDt addEvent()

Adds and returns a new value for event (When the event occurs)

Definition: Identifies specific time periods when the event should occur

getEventFirstRep

public PeriodDt getEventFirstRep()

Gets the first repetition for event (When the event occurs), creating it if it does not already exist.

Definition: Identifies specific time periods when the event should occur

getRepeat

public ScheduleDt.Repeat getRepeat()

Gets the value(s) for repeat (Only if there is none or one event). creating it if it does not exist. Will not return null.

Definition: Identifies a repeating pattern to the intended time periods.

setRepeat

public ScheduleDt setRepeat(ScheduleDt.Repeat theValue)

Sets the value(s) for repeat (Only if there is none or one event)

Definition: Identifies a repeating pattern to the intended time periods.