%Library.Date

Class %Library.Date Extends %DataType [ ClientDataType = DATE, OdbcType = DATE, SqlCategory = DATE, System = 2 ]

The %Date data type class represents a date. The logical value of the %Date data type is in InterSystems IRIS $H format.

Parameters

FORMAT;

Parameter FORMAT;

The format specification for the data type's display value. The value of the FORMAT parameter corresponds to the available parameters of the $ZDATE and $ZDATEH functions, which are used to perform the formatting.

MAXVAL;

Parameter MAXVAL;

The maximum allowed logical value for the data type.

MINVAL;

Parameter MINVAL;

The minimum allowed logical value for the data type.

VALUELIST;

Parameter VALUELIST;

Used for enumerated (multiple-choice) attributes. VALUELIST is either a null string ("") or a delimiter separated list (where the delimiter is the first character) of logical values. If a non-null value is present, then the attribute is restricted to values in the list, and the validation code simply checks to see if the value is in the list.

DISPLAYLIST;

Parameter DISPLAYLIST;

Used for enumerated (multiple-choice) attributes. Used in conjunction with the VALUELIST parameter for enumerated (multiple-choice) attributes. DISPLAYLIST, if not null, represents the display values for the attribute corresponding with the logical values listed in VALUELIST.

The display values are returned by the LogicalToDisplay method.

XSDTYPE

Parameter XSDTYPE = "date";

Declares the XSD type used when projecting XML Schemas.

JSONTYPE

Parameter JSONTYPE = "string";

Methods

XSDToLogical

ClassMethod XSDToLogical(%val As %String) As %Date [ CodeMode = generator, ServerOnly = 1 ]

Converts the SOAP encoded input date value into a %Date value.

LogicalToXSD

ClassMethod LogicalToXSD(%val As %Date) As %String [ CodeMode = generator, ServerOnly = 1 ]

Converts the %Date value to the canonical SOAP encoded value.

JSONToLogical

ClassMethod JSONToLogical(%val As %String) As %Date [ CodeMode = generator, ServerOnly = 1 ]

Converts the JSON input date value into a %Date value.

LogicalToJSON

ClassMethod LogicalToJSON(%val As %Date) As %String [ CodeMode = generator, ServerOnly = 1 ]

Converts the %Date value to the canonical JSON value.

Normalize

ClassMethod Normalize(%val As %RawString) As %Date [ ServerOnly = 1 ]

Converts %val to a normalized value.

IsValid

ClassMethod IsValid(%val As %RawString) As %Status [ CodeMode = generator, ServerOnly = 0 ]

Tests if the logical value %val, which represents a date in $H format, is valid. The validation is based on the class parameter settings used for the class attribute this data type is associated with. In this case, MAXVAL and MINVAL.

LogicalToDisplay

ClassMethod LogicalToDisplay(%val As %Date) As %String [ CodeMode = generator, ServerOnly = 0 ]

Converts the value of %val, which is in logical $H format, into a display string. The formatting is based on the value of the FORMAT parameter.

Returns the formatted value of %val.

DisplayToLogical

ClassMethod DisplayToLogical(%val As %String) As %Date [ CodeMode = generator, ServerOnly = 0 ]

Converts the input value %val, which represents a date, into $H format.

Returns the logical ($H) value of the input string %val.

LogicalToOdbc

ClassMethod LogicalToOdbc(%val As %Date = "") As %String [ CodeMode = generator, ServerOnly = 1 ]

Converts %val, which represents a date in logical $H format, into ODBC date format.

Returns the ODBC date string for the logical ($H) value %val. Assume if the value is already in ODBC DATE format or ODBC TIMESTAMP format, just return tge ODBC DATE format portion of the value. This value may have come from a gateway query or is used by TO_DATE(val,"J") for Julian dates

OdbcToLogical

ClassMethod OdbcToLogical(%val As %String = "") As %Date [ CodeMode = generator, ServerOnly = 1 ]

Converts %val, which represents a date in ODBC format, into $H format.

Returns the $H value of the ODBC date string %val.