Record Class BalancePerformanceReportDTO

java.lang.Object

java.lang.Record

com.bluebell.greenhouse.platform.models.api.dto.account.BalancePerformanceReportDTO

Record Components:

metric - BalancePerformanceMetric

period - BalancePerformancePeriod

effectiveStart - LocalDateTime inclusive UTC report start

effectiveEnd - LocalDateTime exclusive UTC report end

openingBalance - actual balance immediately before the report start

closingSeriesValue - final filtered series value

amountChange - final series value minus its opening value

percentageChange - amount change divided by opening balance, or null for a zero opening balance

points - List of BalancePerformancePointDTOs

public record BalancePerformanceReportDTO(BalancePerformanceMetric metric, BalancePerformancePeriod period, LocalDateTime effectiveStart, LocalDateTime effectiveEnd, double openingBalance, double closingSeriesValue, double amountChange, Double percentageChange, List<BalancePerformancePointDTO> points)
extends Record

Ledger-derived account or portfolio balance-performance report.

Version:

3.0.5

Author:

Stephen Prizio

Constructor Summary

Constructors

Constructor	Description
BalancePerformanceReportDTO(BalancePerformanceMetric metric, BalancePerformancePeriod period, LocalDateTime effectiveStart, LocalDateTime effectiveEnd, double openingBalance, double closingSeriesValue, double amountChange, Double percentageChange, List<BalancePerformancePointDTO> points)	Creates an instance of a BalancePerformanceReportDTO record class.

Method Summary

Modifier and Type	Method	Description
double	amountChange()	Returns the value of the amountChange record component.
double	closingSeriesValue()	Returns the value of the closingSeriesValue record component.
LocalDateTime	effectiveEnd()	Returns the value of the effectiveEnd record component.
LocalDateTime	effectiveStart()	Returns the value of the effectiveStart record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
BalancePerformanceMetric	metric()	Returns the value of the metric record component.
double	openingBalance()	Returns the value of the openingBalance record component.
Double	percentageChange()	Returns the value of the percentageChange record component.
BalancePerformancePeriod	period()	Returns the value of the period record component.
List<BalancePerformancePointDTO>	points()	Returns the value of the points record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BalancePerformanceReportDTO

public BalancePerformanceReportDTO(BalancePerformanceMetric metric,
 BalancePerformancePeriod period,
 LocalDateTime effectiveStart,
 LocalDateTime effectiveEnd,
 double openingBalance,
 double closingSeriesValue,
 double amountChange,
 Double percentageChange,
 List<BalancePerformancePointDTO> points)

Creates an instance of a BalancePerformanceReportDTO record class.

Parameters:

metric - the value for the metric record component

period - the value for the period record component

effectiveStart - the value for the effectiveStart record component

effectiveEnd - the value for the effectiveEnd record component

openingBalance - the value for the openingBalance record component

closingSeriesValue - the value for the closingSeriesValue record component

amountChange - the value for the amountChange record component

percentageChange - the value for the percentageChange record component

points - the value for the points record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

metric

public BalancePerformanceMetric metric()

Returns the value of the metric record component.

Returns:

the value of the metric record component

period

public BalancePerformancePeriod period()

Returns the value of the period record component.

Returns:

the value of the period record component

effectiveStart

public LocalDateTime effectiveStart()

Returns the value of the effectiveStart record component.

Returns:

the value of the effectiveStart record component

effectiveEnd

public LocalDateTime effectiveEnd()

Returns the value of the effectiveEnd record component.

Returns:

the value of the effectiveEnd record component

openingBalance

public double openingBalance()

Returns the value of the openingBalance record component.

Returns:

the value of the openingBalance record component

closingSeriesValue

public double closingSeriesValue()

Returns the value of the closingSeriesValue record component.

Returns:

the value of the closingSeriesValue record component

amountChange

public double amountChange()

Returns the value of the amountChange record component.

Returns:

the value of the amountChange record component

percentageChange

public Double percentageChange()

Returns the value of the percentageChange record component.

Returns:

the value of the percentageChange record component

points

public List<BalancePerformancePointDTO> points()

Returns the value of the points record component.

Returns:

the value of the points record component