Package ca.uhn.fhir.rest.param

Class DateParam

java.lang.Object

ca.uhn.fhir.rest.param.BaseParam

ca.uhn.fhir.rest.param.BaseParamWithPrefix<DateParam>

ca.uhn.fhir.rest.param.DateParam

All Implemented Interfaces:

IQueryParameterOr<DateParam>, IQueryParameterType, Serializable

public class DateParam
extends BaseParamWithPrefix<DateParam>
implements IQueryParameterOr<DateParam>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DateParam.DateParamDateTimeHolder

Field Summary

Fields inherited from class ca.uhn.fhir.rest.param.BaseParamWithPrefix

MSG_PREFIX_INVALID_FORMAT

Constructor Summary

Constructors

Constructor	Description
DateParam()	Constructor
DateParam(ParamPrefixEnum thePrefix, long theDate)	Constructor
DateParam(ParamPrefixEnum thePrefix, DateTimeDt theDate)	Constructor
DateParam(ParamPrefixEnum thePrefix, String theDate)	Constructor
DateParam(ParamPrefixEnum thePrefix, Date theDate)	Constructor
DateParam(ParamPrefixEnum thePrefix, IPrimitiveType<Date> theDate)	Constructor
DateParam(String theString)	Constructor which takes a complete [qualifier]{date} string.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
TemporalPrecisionEnum	getPrecision()
Date	getValue()
String	getValueAsString()
List<DateParam>	getValuesAsQueryTokens()
int	hashCode()
boolean	isEmpty()	Returns true if no date/time is specified.
DateParam	setValue(Date theValue)	Sets the value of the param to the given date (sets to the millisecond precision, and will be encoded using the system local time zone).
void	setValue(IPrimitiveType<Date> theValue)	Sets the value using a FHIR Date type, such as a DateDt, or a DateTimeType.
void	setValueAsString(String theDate)	Accepts values with or without a prefix (e.g.
void	setValuesAsQueryTokens(FhirContext theContext, String theParamName, QualifiedParamList theParameters)
String	toString()

Methods inherited from class ca.uhn.fhir.rest.param.BaseParamWithPrefix

getPrefix, setPrefix

Methods inherited from class ca.uhn.fhir.rest.param.BaseParam

getMissing, getQueryParameterQualifier, getValueAsQueryToken, isSupportsChain, setMissing, setValueAsQueryToken

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DateParam

public DateParam()

Constructor

DateParam

public DateParam(ParamPrefixEnum thePrefix,
 Date theDate)

Constructor

DateParam

public DateParam(ParamPrefixEnum thePrefix,
 DateTimeDt theDate)

Constructor

DateParam

public DateParam(ParamPrefixEnum thePrefix,
 IPrimitiveType<Date> theDate)

Constructor

DateParam

public DateParam(ParamPrefixEnum thePrefix,
 long theDate)

Constructor

DateParam

public DateParam(ParamPrefixEnum thePrefix,
 String theDate)

Constructor

DateParam

public DateParam(String theString)

Constructor which takes a complete [qualifier]{date} string.

Parameters:

theString - The string

Method Details

getPrecision

public TemporalPrecisionEnum getPrecision()

getValue

public Date getValue()

getValueAsString

public String getValueAsString()

getValuesAsQueryTokens

public List<DateParam> getValuesAsQueryTokens()

Specified by:

getValuesAsQueryTokens in interface IQueryParameterOr<DateParam>

isEmpty

public boolean isEmpty()

Returns true if no date/time is specified. Note that this method does not check the comparator, so a QualifiedDateParam with only a comparator and no date/time is considered empty.

setValue

public DateParam setValue(Date theValue)

Sets the value of the param to the given date (sets to the millisecond precision, and will be encoded using the system local time zone).

setValue

public void setValue(IPrimitiveType<Date> theValue)

Sets the value using a FHIR Date type, such as a DateDt, or a DateTimeType.

setValueAsString

public void setValueAsString(String theDate)

Accepts values with or without a prefix (e.g. gt2011-01-01 and 2011-01-01). If no prefix is provided in the given value, the existing prefix is preserved

setValuesAsQueryTokens

public void setValuesAsQueryTokens(FhirContext theContext,
 String theParamName,
 QualifiedParamList theParameters)

Specified by:

setValuesAsQueryTokens in interface IQueryParameterOr<DateParam>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object