%MV.Date

Class %MV.Date Extends %DataType [ ClientDataType = MVDATE, OdbcType = DATE, Not ProcedureBlock, SqlCategory = MVDATE, System = 2 ]

The %MV.Date data type class represents a MultiValue date.

The MultiValue start date is 01/01/1968
ObjectScript date is 01/01/1841

To convert an ObjectScript date ($h) to a MultiValue date:
MVdate = ObjectScript date - 46385

To convert a MultiValue date to an ObjectScript date:
ObjectScript date = MVdate + 46385

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 %MV.Date [ CodeMode = generator, ServerOnly = 1 ]

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

LogicalToXSD

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

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

DisplayToLogical

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

Converts the input value %val, which represents a date, into an MV Date format.

Returns the logical (MV Date) value of the input string %val.

Normalize

ClassMethod Normalize(%val As %String) As %MV.Date [ CodeMode = expression, 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 MV Date 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 MV Date format, into a display string. The formatting is based on the value of the FORMAT parameter.

Returns the formatted value of %val.

LogicalToOdbc

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

Converts %val, which represents a date in logical MV Date format, into ODBC date format.

Returns the ODBC date string for the logical (MV Date) value %val.

OdbcToLogical

ClassMethod OdbcToLogical(%val As %String = "") As %MV.Date [ ProcedureBlock = 1, ServerOnly = 1 ]

Converts %val, which represents a date in ODBC format, into MV Date format.

Returns the MV Date value of the ODBC date string %val.

DateToLogical

ClassMethod DateToLogical(%val As %Library.Date) As %MV.Date [ CodeMode = expression, ServerOnly = 1 ]

Converts %Library.Date value to %MV.Date value

LogicalToDate

ClassMethod LogicalToDate(%val As %MV.Date) As %Library.Date [ CodeMode = expression, ServerOnly = 1 ]

Converts logical %MV.Date value to %Library.Date value