Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%Library] >  [TimeStamp]
Private  Storage   

datatype class %Library.TimeStamp extends %DataType

ODBC Type: TIMESTAMP

The %TimeStamp data type class represents a time stamp value.

The logical value of the %TimeStamp data type is in YYYY-MM-DD HH:MM:SS.nnnnnnnnn format.

The function $System.SQL.DATEDIFF() can be used to return intervals between two %TimeStamp values. The function $System.SQL.DATEADD() can be used to add a certain number of date parts (such as years, hours, or days) to a specified timestamp.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
8 7


Summary

Methods
DisplayToLogical IsValid LogicalToDisplay LogicalToXSD
Normalize OdbcToLogical XSDToLogical

Subclasses
%Library.DateTime %Studio.TimeStamp %xsd.dateTime

Parameters

• 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.

• parameter JSONTYPE = "string";
• parameter MAXVAL;
The maximum allowed logical value for the data type.
• parameter MINVAL;
The minimum allowed logical value for the data type.
• 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.
• parameter XMLTIMEZONE = "UTC";
XMLTIMEZONE specifies the handling of timezone part of the XML format dateTime. "UTC" means convert to UTC on input. "IGNORE" means ignore the timezone.
• parameter XSDTYPE = "dateTime";
Declares the XSD type used when projecting XML Schemas.

Methods

• classmethod DisplayToLogical(%val As %String) as %TimeStamp
Converts the input value %val, which represents a Display timestamp value, to YYYY-MM-DD HH:MM:SS[.nnnnnnnnn] format. The Logical value and Display values are the same unless there are VALUELIST and DISPLAYLIST parameters specified.

Returns the value of the input string %val as a Logical timestamp value (YYYY-MM-DD HH:MM:SS[.nnnnnnnnn] format).

• classmethod IsValid(%val As %RawString) as %Status
Tests if the logical value %val, which represents a timestamp value in YYYY-MM-DD HH:MM:SS[.nnnnnnnn] 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.
• classmethod LogicalToDisplay(%val As %TimeStamp) as %String
Converts the value of %val, which is in logical format YYYY-MM-DD HH:MM:SS[.nnnnnnnnn], into a display string. The Logical value and Display values are the same unless there are VALUELIST and DISPLAYLIST parameters specified.

Returns the Display Timestamp value of the Logical Timestamp string %val.

• classmethod LogicalToXSD(%val As %TimeStamp) as %String
Converts the %TimeStamp value to the canonical SOAP encoded value.
• classmethod Normalize(%val As %RawString) as %TimeStamp
Transforms Logical Date or ODBC Date values into timestamp. Date values are converted to Timestamp values with a time of 00:00:00.
• classmethod OdbcToLogical(%val As %String) as %TimeStamp
Converts %val, which represents either a Timestamp in ODBC format, or a Date in ODBC format, into a logical Timestamp value.

Returns the logical Timestamp value of the ODBC Timestamp string %val.

• classmethod XSDToLogical(%val As %String) as %TimeStamp
Converts the SOAP encoded input dateTime value into a %TimeStamp value.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.