Difference between revisions of "Extensions.DateTime.FormatDate"
Jump to navigation
Jump to search
Line 3: | Line 3: | ||
{{ClassificationActivity | FormatDate | Returns a formatted time representation of a timestamp. | [[Term]] | [[DateTime|OTX DateTime Extension]] | - | [[OutOfBoundsException]] | - | Yes}} | {{ClassificationActivity | FormatDate | Returns a formatted time representation of a timestamp. | [[Term]] | [[DateTime|OTX DateTime Extension]] | - | [[OutOfBoundsException]] | - | Yes}} | ||
− | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
− | String time = FormatDate( | + | String time = FormatDate(IntegerTerm , StringTerm); |
</syntaxhighlight> | </syntaxhighlight> | ||
Line 35: | Line 35: | ||
|} | |} | ||
− | == Examples == | + | == OTL Examples == |
− | + | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | |
− | + | String CurrentTime; | |
− | |||
+ | CurrentTime = DateTime.FormatDate(DateTime.GetTimestamp(), null); | ||
+ | </syntaxhighlight> | ||
== See also == | == See also == | ||
[[GetTimeStamp]]<br/> | [[GetTimeStamp]]<br/> | ||
[[FormatDuration]] | [[FormatDuration]] |
Revision as of 10:26, 4 February 2015
Contents
Classification
Name | FormatDate |
Short Description | Returns a formatted time representation of a timestamp. |
Class | Term |
Extension | OTX DateTime Extension |
Group | - |
Exceptions | OutOfBoundsException |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
String time = FormatDate(IntegerTerm , StringTerm);
Description
Date format is a term which converts a timestamp in a date format and returns as a string. If there is no formatting specified, is the time to ISO 8601:2004 in the following format:
YYYY-MM-DDThh:mm:ss[.fff]+hh:mm
(The symbols "-", ".", ":", ",", "+" And "T" are delimiters)
The following table gives an overview of the decoding of the individual format icons.
YYYY | MM | DD | hh | mm | ss | fff | hh | mm |
Year | Month | Day | Hour | Minute | Second | Milisecond | Hour (difference from GMT) | Minute (difference from GMT) |
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
Data Type | Description |
String | Date in the form according to ISO8601 or as specified. |
Properties
Name | Data Type | Class | Default | Cardinality | Description |
Timestamp | Integer | Term | - | [0..1] | This property specifies a date as a time stamp, which is interpreted as the number of milliseconds elapsed since January 1 1970 00:00:00 UTC. |
Pattern | String | Term | - | [0..1] | This feature can represent time in the desired format. |
OTL Examples
String CurrentTime;
CurrentTime = DateTime.FormatDate(DateTime.GetTimestamp(), null);