The objects of this server class store duration as a date and time from starting with January 1, 1970, 00:00:00.
SimpleDuration(duration)
Instantiates a new SimpleDuration object.
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|
| duration | Integer (seconds) | N | '' |
| duration | String (duration displayValue) | N | '' |
Example:
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | SimpleDuration |
|---|
| linenumbers | true |
|---|
|
const durationOne = new SimpleDuration(3600);
const durationTwo = new SimpleDuration('00:30:00'); |
add(duration)
Summarizes This method sums two SimpleDuration objects and returns the result.
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|
| duration | SimpleDuration | Y | N |
Return:
| Type | Description |
|---|
| SimpleDuration | The sum of the two SimpleDuration objects. |
Example:
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | add |
|---|
| linenumbers | true |
|---|
|
varconst simple_durationdurationOne = new SimpleDuration("2 10:00:00"3600);
var simple_duration_1const durationTwo = new SimpleDuration("01'00:0030:00"');
varconst resulttotalDuration = simple_durationdurationOne.add(simple_duration_1durationTwo);
ss.info( resulttotalDuration.getDisplayValuegetDurationValue() );
// Info: 01:30:00 |
Returns This method allows to get the duration value of the duration in a specified the format you need.
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|
| format | String | N | 'Y-m-d H:i:s' |
Return:
| Type | Description |
|---|
| String | SimpleDuration object |
Example:
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | getByFormat |
|---|
| linenumbers | true |
|---|
|
const datetimevar simple_duration = new SimpleDuration("2 10:00:00"SimpleDateTime('2019-11-12 15:34:13');
const duration = new SimpleDuration(datetime.getNumericValue());
ss.info( simple_duration.getByFormat('h:m') );j F Y (D) H:i:s'));
// Info: 12 November 2019 (Tue) 15:34:13 |
getDayPart()
Returns the This method allows to get the duration value in number of the days of the duration.
Return:
| Type | Description |
|---|
| Integer | The number of the days. |
Example:
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | getDayPart |
|---|
| linenumbers | true |
|---|
|
constvar simple_duration = new SimpleDuration("2'02 1001:0030:00"');
ss.info( simple_duration.getDayPart() );
// Info: 2 |
getDisplayValue()
Returns This method allows to get the number of the days, hours, and minutes of from the durationSimpleDuration object.
Return:
| Type | Description |
|---|
| String | The number of the days, hours and minutes. |
Example:
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | getDisplayValue |
|---|
| linenumbers | true |
|---|
|
varconst simple_duration = new SimpleDuration(3605);
ss.info(duration.getDisplayValue());
// Info: 1 hour 5 seconds |
getDurationSeconds()
This method returns the duration value in seconds.
Return:
| Type | Description |
|---|
| Integer | The duration value in seconds. |
Example:
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | getDurationSeconds |
|---|
| linenumbers | true |
|---|
|
const duration = new SimpleDuration('("10 10:00:00"');
ss.info( simple_duration.getDisplayValuegetDurationSeconds() );
//10 days 10 hoursInfo: 36000 |
getDurationValue()
Returns This method allows to get the duration value in from the SimpleDuration object in 'D H:i:s' format.
Return:
| Type | Description |
|---|
| String | The duration value. |
Example:
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | getDurationValue |
|---|
| linenumbers | true |
|---|
|
const var simple_duration = new SimpleDuration("10 10:00:00"7200);
ss.info( simple_duration.getDurationValue() );
//10 Info: 1002:00:00 |
getRoundedDayPart()
Returns This method returns the rounded number of days taking into account the quantity of hours in the SimpleDuration object. If the number of hours is more than 12, then round the method rounds the value up. Otherwise, round it rounds the value down.
Return:
| Type | Description |
|---|
| Integer | The rounded number of days. |
Example:
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | getRoundedDayPart |
|---|
|
var simple_duration = new SimpleDuration("10 10:00:00");
ss.info( simple_duration.getRoundedDayPart() ); // 10 |
|
const |
| Code Block |
|---|
| language | js |
|---|
| title | getRoundedDayPart |
|---|
|
var simple_duration = new SimpleDuration("10'5 1412:0052:00"22');
ss.info( simple_duration.getRoundedDayPart() );
//Info: 116 |
getValue()
Returns the internal value of the SimpleDuration objectThis method returns the date and time value in the internal format.
SimpleDuration objects store
the duration as a date and time
past January starting with January 1, 1970, 00:00:00.
Return:
| Type | Description |
|---|
| String | The duration string in the object's internal format. |
Example:
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | getValue |
|---|
| linenumbers | true |
|---|
|
constvar simple_duration = new SimpleDuration("'10 15:00:00"');
ss.info( simple_duration.getValue() );
//Info: 1970-01-11 15:00:00 |
Example 2:
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | getValue |
|---|
| linenumbers | true |
|---|
|
const myUserId = ss.getUserId();
const timestamp = Number(myUserId.slice(0, 10)); // User created at
const duration = new SimpleDuration(timestamp);
ss.info(duration.getValue());
// Info: 2019-05-31 14:02:39 |
setDisplayValue(duration)
Sets This method sets the value in a 'd H:i:s' format.
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|
| duration | String | Y | N |
Return:
| Type | Description |
|---|
| Void | This method does not return a value. |
Example:
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | setDisplayValue |
|---|
| linenumbers | true |
|---|
|
const var simple_duration = new SimpleDuration();
simple_duration.setDisplayValue("'2 10:00:00"');
ss.info( simple_duration.getDisplayValue() );
//Info: 2 days 10 hours |
setValue(
string / SimpleDateTime dateTime)
Sets This method sets the value in a a 'YYYYY-mMM-d HDD hh:imm:sss' format.
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|
| dateTime | String | Y | N |
| dateTime | SimpleDateTime | Y | N |
Return:
| Type | Description |
|---|
| Void | This method does not return a value. |
Example:
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | setValue |
|---|
| linenumbers | true |
|---|
|
varconst simple_durationdurationOne = new SimpleDuration();
simple_durationdurationOne.setValue("2 10'2019-08-01 09:00:00"');
ss.info(durationOne.getByFormat());
const durationTwo = new SimpleDuration();
durationTwo.setValue( simple_duration.getDisplayValue() );new SimpleDateTime('2019-09-05 12:00:00'));
ss.info(durationTwo.getByFormat());
// Info: 2019-08-01 09:00:00
// Info: 2019-09-05 12:00:00 |
subtract(duration)
Subtracts This method subtracts one SimpleDuration object from another and returns the result.
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|
| duration | SimpleDuration | Y | N |
Return:
| Type | Description |
|---|
| SimpleDuration | The subtraction result object. |
Example:
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| title | subtract |
|---|
| linenumbers | true |
|---|
|
const durationOnevar simple_duration = new SimpleDuration();
durationOne.setValue('10 05:00:002019-11-08 20:01:58');
var simple_duration_1const durationTwo = new SimpleDuration('05:00:00'3600);
varconst datetime result= simple_duration durationOne.subtract(simple_duration_1durationTwo);
ss.info( resultdatetime.getDisplayValuegetByFormat() );
// Info: 2019-11-08 19:01:58 |