PaymentSummary (Broadleaf Order Common 1.4.0-GA API)

java.lang.Object
- com.broadleafcommerce.order.common.domain.PaymentSummary

All Implemented Interfaces:

Serializable
```
public class PaymentSummary
extends Object
implements Serializable
```
The domain that summarizes the current state of transactions against the payment.

Author:

Dima Myroniuk (dmyroniuk)

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PaymentSummary()

Constructors
Constructor and Description
`PaymentSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`javax.money.MonetaryAmount`	`getAdjustmentsTotal()`
`javax.money.MonetaryAmount`	`getAmount()`
`javax.money.MonetaryAmount`	`getAmountAuthorized()` The total authorized amount for capture.
`javax.money.MonetaryAmount`	`getAmountCaptured()` The total captured amount.
`javax.money.MonetaryAmount`	`getAmountCredited()` The total detached credit amount.
`javax.money.MonetaryAmount`	`getAmountRefunded()` The total refunded amount.
`javax.money.MonetaryAmount`	`getAmountSettled()` The total settled amount.
`javax.money.MonetaryAmount`	`getAmountVoided()` The total voided amount.
`Map<String,String>`	`getAttributes()`
`Map<String,String>`	`getDisplayAttributes()`
`javax.money.MonetaryAmount`	`getFulfillmentTotal()`
`String`	`getGatewayType()`
`Boolean`	`getIsSingleUsePaymentMethod()`
`String`	`getName()`
`String`	`getPaymentId()`
`javax.money.MonetaryAmount`	`getSubtotal()`
`javax.money.MonetaryAmount`	`getTaxTotal()`
`int`	`hashCode()`
`void`	`setAdjustmentsTotal(javax.money.MonetaryAmount adjustmentsTotal)`
`void`	`setAmount(javax.money.MonetaryAmount amount)`
`void`	`setAmountAuthorized(javax.money.MonetaryAmount amountAuthorized)` The total authorized amount for capture.
`void`	`setAmountCaptured(javax.money.MonetaryAmount amountCaptured)` The total captured amount.
`void`	`setAmountCredited(javax.money.MonetaryAmount amountCredited)` The total detached credit amount.
`void`	`setAmountRefunded(javax.money.MonetaryAmount amountRefunded)` The total refunded amount.
`void`	`setAmountSettled(javax.money.MonetaryAmount amountSettled)` The total settled amount.
`void`	`setAmountVoided(javax.money.MonetaryAmount amountVoided)` The total voided amount.
`void`	`setAttributes(Map<String,String> attributes)`
`void`	`setDisplayAttributes(Map<String,String> displayAttributes)`
`void`	`setFulfillmentTotal(javax.money.MonetaryAmount fulfillmentTotal)`
`void`	`setGatewayType(String gatewayType)`
`void`	`setIsSingleUsePaymentMethod(Boolean isSingleUsePaymentMethod)`
`void`	`setName(String name)`
`void`	`setPaymentId(String paymentId)`
`void`	`setSubtotal(javax.money.MonetaryAmount subtotal)`
`void`	`setTaxTotal(javax.money.MonetaryAmount taxTotal)`
`String`	`toString()`

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

- Constructor Detail
  - PaymentSummary
```
public PaymentSummary()
```
- Method Detail
  - getPaymentId
```
public String getPaymentId()
```
    See Also:
    
    Payment.getId()
  - getName
```
public String getName()
```
    See Also:
    
    Payment.getName()
  - getGatewayType
```
public String getGatewayType()
```
    See Also:
    
    Payment.getGatewayType()
  - getAttributes
```
public Map<String,String> getAttributes()
```
    See Also:
    
    Payment.getAttributes()
  - getDisplayAttributes
```
public Map<String,String> getDisplayAttributes()
```
    See Also:
    
    Payment.getDisplayAttributes()
  - getIsSingleUsePaymentMethod
```
public Boolean getIsSingleUsePaymentMethod()
```
    See Also:
    
    Payment.isSingleUsePaymentMethod()
  - getAmount
```
public javax.money.MonetaryAmount getAmount()
```
    See Also:
    
    Payment.getAmount()
  - getSubtotal
```
public javax.money.MonetaryAmount getSubtotal()
```
    See Also:
    
    Payment.getSubtotal()
  - getAdjustmentsTotal
```
public javax.money.MonetaryAmount getAdjustmentsTotal()
```
    See Also:
    
    Payment.getAdjustmentsTotal()
  - getFulfillmentTotal
```
public javax.money.MonetaryAmount getFulfillmentTotal()
```
    See Also:
    
    Payment.getFulfillmentTotal()
  - getTaxTotal
```
public javax.money.MonetaryAmount getTaxTotal()
```
    See Also:
    
    Payment.getTaxTotal()
  - getAmountAuthorized
```
public javax.money.MonetaryAmount getAmountAuthorized()
```
    The total authorized amount for capture. This value is calculated as "total authorized - total reverse-authed".
    
    Returns:
    
    the total authorized amount for capture
  - getAmountCaptured
```
public javax.money.MonetaryAmount getAmountCaptured()
```
    The total captured amount. This value is calculated as "total captured - total refunded - total voided".
    
    Returns:
    
    the total captured amount
  - getAmountRefunded
```
public javax.money.MonetaryAmount getAmountRefunded()
```
    The total refunded amount.
    
    Returns:
    
    the total refunded amount
  - getAmountVoided
```
public javax.money.MonetaryAmount getAmountVoided()
```
    The total voided amount.
    
    Returns:
    
    the total voided amount
  - getAmountSettled
```
public javax.money.MonetaryAmount getAmountSettled()
```
    The total settled amount.
    
    Returns:
    
    the total settled amount
  - getAmountCredited
```
public javax.money.MonetaryAmount getAmountCredited()
```
    The total detached credit amount.
    
    Returns:
    
    the total detached credit amount
  - setPaymentId
```
public void setPaymentId(String paymentId)
```
    See Also:
    
    Payment.getId()
  - setName
```
public void setName(String name)
```
    See Also:
    
    Payment.getName()
  - setGatewayType
```
public void setGatewayType(String gatewayType)
```
    See Also:
    
    Payment.getGatewayType()
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    See Also:
    
    Payment.getAttributes()
  - setDisplayAttributes
```
public void setDisplayAttributes(Map<String,String> displayAttributes)
```
    See Also:
    
    Payment.getDisplayAttributes()
  - setIsSingleUsePaymentMethod
```
public void setIsSingleUsePaymentMethod(Boolean isSingleUsePaymentMethod)
```
    See Also:
    
    Payment.isSingleUsePaymentMethod()
  - setAmount
```
public void setAmount(javax.money.MonetaryAmount amount)
```
    See Also:
    
    Payment.getAmount()
  - setSubtotal
```
public void setSubtotal(javax.money.MonetaryAmount subtotal)
```
    See Also:
    
    Payment.getSubtotal()
  - setAdjustmentsTotal
```
public void setAdjustmentsTotal(javax.money.MonetaryAmount adjustmentsTotal)
```
    See Also:
    
    Payment.getAdjustmentsTotal()
  - setFulfillmentTotal
```
public void setFulfillmentTotal(javax.money.MonetaryAmount fulfillmentTotal)
```
    See Also:
    
    Payment.getFulfillmentTotal()
  - setTaxTotal
```
public void setTaxTotal(javax.money.MonetaryAmount taxTotal)
```
    See Also:
    
    Payment.getTaxTotal()
  - setAmountAuthorized
```
public void setAmountAuthorized(javax.money.MonetaryAmount amountAuthorized)
```
    The total authorized amount for capture. This value is calculated as "total authorized - total reverse-authed".
    
    Parameters:
    
    amountAuthorized - the total authorized amount for capture
  - setAmountCaptured
```
public void setAmountCaptured(javax.money.MonetaryAmount amountCaptured)
```
    The total captured amount. This value is calculated as "total captured - total refunded - total voided".
    
    Parameters:
    
    amountCaptured - the total captured amount
  - setAmountRefunded
```
public void setAmountRefunded(javax.money.MonetaryAmount amountRefunded)
```
    The total refunded amount.
    
    Parameters:
    
    amountRefunded - the total refunded amount
  - setAmountVoided
```
public void setAmountVoided(javax.money.MonetaryAmount amountVoided)
```
    The total voided amount.
    
    Parameters:
    
    amountVoided - the total voided amount
  - setAmountSettled
```
public void setAmountSettled(javax.money.MonetaryAmount amountSettled)
```
    The total settled amount.
    
    Parameters:
    
    amountSettled - the total settled amount
  - setAmountCredited
```
public void setAmountCredited(javax.money.MonetaryAmount amountCredited)
```
    The total detached credit amount.
    
    Parameters:
    
    amountCredited - the total detached credit amount
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PaymentSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PaymentSummary

Method Detail

getPaymentId

getName

getGatewayType

getAttributes

getDisplayAttributes

getIsSingleUsePaymentMethod

getAmount

getSubtotal

getAdjustmentsTotal

getFulfillmentTotal

getTaxTotal

getAmountAuthorized

getAmountCaptured

getAmountRefunded

getAmountVoided

getAmountSettled

getAmountCredited

setPaymentId

setName

setGatewayType

setAttributes

setDisplayAttributes

setIsSingleUsePaymentMethod

setAmount

setSubtotal

setAdjustmentsTotal

setFulfillmentTotal

setTaxTotal

setAmountAuthorized

setAmountCaptured

setAmountRefunded

setAmountVoided

setAmountSettled

setAmountCredited

equals

canEqual

hashCode

toString