DurationRecord (LSPS 3.3 SDK)

java.lang.Object
- com.whitestein.lsps.lang.RecordWrapper
- - com.whitestein.lsps.lang.DurationRecord

All Implemented Interfaces:

IRecordWrapper
```
public class DurationRecord
extends RecordWrapper
```
A wrapper class for core::Duration record.

Author:

mvo

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DAYS` Property name of days field.
`static String`	`DURATION_TYPE` A full type name of core::Duration type.
`static String`	`HOURS` Property name of hours field.
`static String`	`MILLIS` Property name of millis field.
`static String`	`MINUTES` Property name of minutes field.
`static String`	`MONTHS` Property name of months field.
`static String`	`SECONDS` Property name of seconds field.
`static String`	`WEEKS` Property name of weeks field.
`static String`	`YEARS` Property name of years field.

Constructor Summary

Constructors
Constructor and Description
`DurationRecord()` Creates a new record wrapper instance with no record holder.
`DurationRecord(long months, long millis)` Creates a new duration with a given number of months and milliseconds.
`DurationRecord(RecordHolder holder)` Creates a new record wrapper instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Date`	`addTo(Date date)` Returns a date equal to `date - duration`.
`java.time.LocalDate`	`addTo(java.time.LocalDate date)` Returns a date equal to `date + duration`.
`java.time.LocalDateTime`	`addTo(java.time.LocalDateTime date)` Returns a date equal to `date + duration`.
`int`	`getDays()` Returns the days property.
`Decimal`	`getDaysDecimal()` Returns the days property.
`int`	`getHours()` Returns the hours property.
`Decimal`	`getHoursDecimal()` Returns the hours property.
`int`	`getMillis()` Returns the millis property.
`Decimal`	`getMillisDecimal()` Returns the millis property.
`int`	`getMinutes()` Returns the minutes property.
`Decimal`	`getMinutesDecimal()` Returns the minutes property.
`int`	`getMonths()` Returns the months property.
`Decimal`	`getMonthsDecimal()` Returns the months property.
`int`	`getSeconds()` Returns the seconds property.
`Decimal`	`getSecondsDecimal()` Returns the seconds property.
`long`	`getTotalMillis()` Gets the total milliseconds in this duration.
`long`	`getTotalMonths()` Gets the total number of months in this duration.
`String`	`getTypeName()` Returns the full type name of the record.
`int`	`getWeeks()` Returns the weeks property.
`Decimal`	`getWeeksDecimal()` Returns the weeks property.
`int`	`getYears()` Returns the years property.
`Decimal`	`getYearsDecimal()` Returns the years property.
`boolean`	`isDayTimeDuration()` Returns `true` if the duration contains only weeks, days and time components.
`boolean`	`isYearMonthDuration()` Returns `true` if the duration contains only years and months components.
`DurationRecord`	`minus(DurationRecord d)` Creates a new duration by subtract a given duration from this.
`DurationRecord`	`plus(DurationRecord d)` Creates a new duration by adding this and a given duration.
`void`	`setDays(Decimal days)` Sets the days property.
`void`	`setDays(int days)` Sets the days property.
`void`	`setHours(Decimal hours)` Sets the hours property.
`void`	`setHours(int hours)` Sets the hours property.
`void`	`setMillis(Decimal millis)` Sets the millis property.
`void`	`setMillis(int millis)` Sets the millis property.
`void`	`setMinutes(Decimal minutes)` Sets the minutes property.
`void`	`setMinutes(int minutes)` Sets the minutes property.
`void`	`setMonths(Decimal months)` Sets the months property.
`void`	`setMonths(int months)` Sets the months property.
`void`	`setSeconds(Decimal seconds)` Sets the seconds property.
`void`	`setSeconds(int seconds)` Sets the seconds property.
`void`	`setWeeks(Decimal weeks)` Sets the weeks property.
`void`	`setWeeks(int weeks)` Sets the weeks property.
`void`	`setYears(Decimal years)` Sets the years property.
`void`	`setYears(int years)` Sets the years property.
`Date`	`subtractFrom(Date date)` Returns a date equal to `date - duration`.
`java.time.LocalDate`	`subtractFrom(java.time.LocalDate date)` Returns a date equal to `date - duration`.
`java.time.LocalDateTime`	`subtractFrom(java.time.LocalDateTime date)` Returns a date equal to `date - duration`.

Methods inherited from class com.whitestein.lsps.lang.RecordWrapper
asMap, create, equals, getIntProperty, getProperty, hashCode, holder, isCreated, setIntProperty, setProperty, toCollection, toList, toSet, toString, unwrap

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DURATION_TYPE
```
public static final String DURATION_TYPE
```
    A full type name of core::Duration type.
    
    See Also:
    
    Constant Field Values
  - YEARS
```
public static final String YEARS
```
    Property name of years field.
    
    See Also:
    
    Constant Field Values
  - MONTHS
```
public static final String MONTHS
```
    Property name of months field.
    
    See Also:
    
    Constant Field Values
  - WEEKS
```
public static final String WEEKS
```
    Property name of weeks field.
    
    See Also:
    
    Constant Field Values
  - DAYS
```
public static final String DAYS
```
    Property name of days field.
    
    See Also:
    
    Constant Field Values
  - HOURS
```
public static final String HOURS
```
    Property name of hours field.
    
    See Also:
    
    Constant Field Values
  - MINUTES
```
public static final String MINUTES
```
    Property name of minutes field.
    
    See Also:
    
    Constant Field Values
  - SECONDS
```
public static final String SECONDS
```
    Property name of seconds field.
    
    See Also:
    
    Constant Field Values
  - MILLIS
```
public static final String MILLIS
```
    Property name of millis field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DurationRecord
```
public DurationRecord()
```
    Creates a new record wrapper instance with no record holder.
  - DurationRecord
```
public DurationRecord(RecordHolder holder)
```
    Creates a new record wrapper instance.
    
    Parameters:
    
    holder -
  - DurationRecord
```
public DurationRecord(long months,
                      long millis)
```
    Creates a new duration with a given number of months and milliseconds.
    
    Parameters:
    
    months -
    
    millis -
- Method Detail
  - getTypeName
```
public String getTypeName()
```
    Description copied from interface: IRecordWrapper
    
    Returns the full type name of the record.
    
    Specified by:
    
    getTypeName in interface IRecordWrapper
    
    Specified by:
    
    getTypeName in class RecordWrapper
    
    Returns:
    
    the full type name of the record
  - getYears
```
public int getYears()
```
    Returns the years property.
    
    Returns:
    
    years
  - getYearsDecimal
```
public Decimal getYearsDecimal()
```
    Returns the years property.
    
    Returns:
    
    years
  - setYears
```
public void setYears(int years)
```
    Sets the years property.
    
    Parameters:
    
    years -
  - setYears
```
public void setYears(Decimal years)
```
    Sets the years property.
    
    Parameters:
    
    years -
  - getMonths
```
public int getMonths()
```
    Returns the months property.
    
    Returns:
    
    months
  - getMonthsDecimal
```
public Decimal getMonthsDecimal()
```
    Returns the months property.
    
    Returns:
    
    months
  - setMonths
```
public void setMonths(int months)
```
    Sets the months property.
    
    Parameters:
    
    months -
  - setMonths
```
public void setMonths(Decimal months)
```
    Sets the months property.
    
    Parameters:
    
    months -
  - getWeeks
```
public int getWeeks()
```
    Returns the weeks property.
    
    Returns:
    
    weeks
  - getWeeksDecimal
```
public Decimal getWeeksDecimal()
```
    Returns the weeks property.
    
    Returns:
    
    weeks
  - setWeeks
```
public void setWeeks(int weeks)
```
    Sets the weeks property.
    
    Parameters:
    
    weeks -
  - setWeeks
```
public void setWeeks(Decimal weeks)
```
    Sets the weeks property.
    
    Parameters:
    
    weeks -
  - getDays
```
public int getDays()
```
    Returns the days property.
    
    Returns:
    
    days
  - getDaysDecimal
```
public Decimal getDaysDecimal()
```
    Returns the days property.
    
    Returns:
    
    days
  - setDays
```
public void setDays(int days)
```
    Sets the days property.
    
    Parameters:
    
    days -
  - setDays
```
public void setDays(Decimal days)
```
    Sets the days property.
    
    Parameters:
    
    days -
  - getHours
```
public int getHours()
```
    Returns the hours property.
    
    Returns:
    
    hours
  - getHoursDecimal
```
public Decimal getHoursDecimal()
```
    Returns the hours property.
    
    Returns:
    
    hours
  - setHours
```
public void setHours(int hours)
```
    Sets the hours property.
    
    Parameters:
    
    hours -
  - setHours
```
public void setHours(Decimal hours)
```
    Sets the hours property.
    
    Parameters:
    
    hours -
  - getMinutes
```
public int getMinutes()
```
    Returns the minutes property.
    
    Returns:
    
    minutes
  - getMinutesDecimal
```
public Decimal getMinutesDecimal()
```
    Returns the minutes property.
    
    Returns:
    
    minutes
  - setMinutes
```
public void setMinutes(int minutes)
```
    Sets the minutes property.
    
    Parameters:
    
    minutes -
  - setMinutes
```
public void setMinutes(Decimal minutes)
```
    Sets the minutes property.
    
    Parameters:
    
    minutes -
  - getSeconds
```
public int getSeconds()
```
    Returns the seconds property.
    
    Returns:
    
    seconds
  - getSecondsDecimal
```
public Decimal getSecondsDecimal()
```
    Returns the seconds property.
    
    Returns:
    
    seconds
  - setSeconds
```
public void setSeconds(int seconds)
```
    Sets the seconds property.
    
    Parameters:
    
    seconds -
  - setSeconds
```
public void setSeconds(Decimal seconds)
```
    Sets the seconds property.
    
    Parameters:
    
    seconds -
  - getMillis
```
public int getMillis()
```
    Returns the millis property.
    
    Returns:
    
    millis
  - getMillisDecimal
```
public Decimal getMillisDecimal()
```
    Returns the millis property.
    
    Returns:
    
    millis
  - setMillis
```
public void setMillis(int millis)
```
    Sets the millis property.
    
    Parameters:
    
    millis -
  - setMillis
```
public void setMillis(Decimal millis)
```
    Sets the millis property.
    
    Parameters:
    
    millis -
  - isYearMonthDuration
```
public boolean isYearMonthDuration()
```
    Returns true if the duration contains only years and months components.
    
    Returns:
    
    true if the duration is "yearMonthDuration"
  - getTotalMonths
```
public long getTotalMonths()
```
    Gets the total number of months in this duration. Weeks, days and time components are not included.
    
    Returns:
    
    the number months
  - isDayTimeDuration
```
public boolean isDayTimeDuration()
```
    Returns true if the duration contains only weeks, days and time components.
    
    Returns:
    
    true if the duration is "dayTimeDuration"
  - getTotalMillis
```
public long getTotalMillis()
```
    Gets the total milliseconds in this duration. Years and months are not included.
    
    Returns:
    
    the duration in milliseconds
  - plus
```
public DurationRecord plus(DurationRecord d)
```
    Creates a new duration by adding this and a given duration.
    
    Parameters:
    
    d -
    
    Returns:
    
    this + duration
  - minus
```
public DurationRecord minus(DurationRecord d)
```
    Creates a new duration by subtract a given duration from this.
    
    Parameters:
    
    d -
    
    Returns:
    
    this - duration
  - addTo
```
public Date addTo(Date date)
```
    Returns a date equal to date - duration.
    
    Parameters:
    
    date -
    
    Returns:
    
    a date equal to date - duration
  - addTo
```
public java.time.LocalDate addTo(java.time.LocalDate date)
```
    Returns a date equal to date + duration.
    
    Parameters:
    
    date -
    
    Returns:
    
    a date equal to date + duration
  - addTo
```
public java.time.LocalDateTime addTo(java.time.LocalDateTime date)
```
    Returns a date equal to date + duration.
    
    Parameters:
    
    date -
    
    Returns:
    
    a date equal to date + duration
  - subtractFrom
```
public Date subtractFrom(Date date)
```
    Returns a date equal to date - duration.
    
    Parameters:
    
    date -
    
    Returns:
    
    a date equal to date - duration
  - subtractFrom
```
public java.time.LocalDate subtractFrom(java.time.LocalDate date)
```
    Returns a date equal to date - duration.
    
    Parameters:
    
    date -
    
    Returns:
    
    a date equal to date - duration
  - subtractFrom
```
public java.time.LocalDateTime subtractFrom(java.time.LocalDateTime date)
```
    Returns a date equal to date - duration.
    
    Parameters:
    
    date -
    
    Returns:
    
    a date equal to date - duration

Class DurationRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.whitestein.lsps.lang.RecordWrapper

Methods inherited from class java.lang.Object

Field Detail

DURATION_TYPE

YEARS

MONTHS

WEEKS

DAYS

HOURS

MINUTES

SECONDS

MILLIS

Constructor Detail

DurationRecord

DurationRecord

DurationRecord

Method Detail

getTypeName

getYears

getYearsDecimal

setYears

setYears

getMonths

getMonthsDecimal

setMonths

setMonths

getWeeks

getWeeksDecimal

setWeeks

setWeeks

getDays

getDaysDecimal

setDays

setDays

getHours

getHoursDecimal

setHours

setHours

getMinutes

getMinutesDecimal

setMinutes

setMinutes

getSeconds

getSecondsDecimal

setSeconds

setSeconds

getMillis

getMillisDecimal

setMillis

setMillis

isYearMonthDuration

getTotalMonths

isDayTimeDuration

getTotalMillis

plus

minus

addTo

addTo

addTo

subtractFrom

subtractFrom

subtractFrom