IRISLIB database
StringTimeStamp Class Reference

The StringTimeStamp data type class represents a time stamp value. More...

Inheritance diagram for StringTimeStamp:
Collaboration diagram for StringTimeStamp:

Static Public Member Functions

_.Library.TimeStamp DisplayToLogical (_, _.Library.String val)
 Converts the input value val, which represents a timestamp value,. More...
 
_.Library.Status IsValid (_, _.Library.RawString val)
 Tests if the logical value val, which represents a timestamp. More...
 
_.Library.String LogicalToDisplay (_, _.Library.TimeStamp val)
 Converts the value of val, which is in logical format YYYY-MM-DD HH:MM:SS,. More...
 
_.Library.String LogicalToXSD (_, _.Library.StringTimeStamp val)
 Converts the StringTimeStamp value to the canonical SOAP encoded value.
 
_.Library.TimeStamp Normalize (_, _.Library.RawString val)
 Transforms integer values into timestamp.
 
_.Library.TimeStamp OdbcToLogical (_, _.Library.String val)
 Converts val, which represents either a Timestamp in ODBC format,. More...
 
_.Library.StringTimeStamp XSDToLogical (_, _.Library.String val)
 Converts the SOAP encoded input dateTime value into a TimeStamp value.
 

Static Public Attributes

 DISPLAYLIST = None
 The StringTimeStamp data type class represents a time stamp value. More...
 
 JSONTYPE = None
 JSONTYPE is JSON type used for this datatype.
 
 MAXVAL = None
 The maximum allowed logical value for the data type.
 
 MINVAL = None
 The minimum allowed logical value for the data type.
 
 VALUELIST = None
 Used for enumerated (multiple-choice) attributes. More...
 
 XMLTIMEZONE = None
 XMLTIMEZONE specifies the handling of timezone part of the XML format dateTime. More...
 
 XSDTYPE = None
 Declares the XSD type used when projecting XML Schemas.
 
- Static Public Attributes inherited from DataType
 INDEXNULLMARKER = None
 Override this parameter value to specify what value should be used as a null marker when a property of the type is used in a subscript of an index map. More...
 

Detailed Description

The StringTimeStamp data type class represents a time stamp value.

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

Member Function Documentation

◆ DisplayToLogical()

_.Library.TimeStamp DisplayToLogical (   _,
_.Library.String  val 
)
static

Converts the input value val, which represents a timestamp value,.

to YYYY-MM-DD HH:MM:SS format.

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

◆ IsValid()

_.Library.Status IsValid (   _,
_.Library.RawString  val 
)
static

Tests if the logical value val, which represents a timestamp.

value in YYYY-MM-DD HH:MM:SS 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.

Reimplemented from DataType.

◆ LogicalToDisplay()

_.Library.String LogicalToDisplay (   _,
_.Library.TimeStamp  val 
)
static

Converts the value of val, which is in logical format YYYY-MM-DD HH:MM:SS,.

into a display string. The formatting is based on the value of the FORMAT parameter.

Returns the formatted value of val.

◆ OdbcToLogical()

_.Library.TimeStamp OdbcToLogical (   _,
_.Library.String  val 
)
static

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.

Member Data Documentation

◆ DISPLAYLIST

DISPLAYLIST = None
static

The StringTimeStamp data type class represents a time stamp value.

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

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.

◆ VALUELIST

VALUELIST = None
static

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.

◆ XMLTIMEZONE

XMLTIMEZONE = None
static

XMLTIMEZONE specifies the handling of timezone part of the XML format dateTime.

"UTC" means convert to UTC on input. "IGNORE means ignore the timezone.