Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ace.mws.mam
[Groovy] Class FundBalance

java.lang.Object
  com.ace.mws.mam.FundBalance

class FundBalance

Represents a report of fund balance.

Authors:
bsaville

Field Summary
private BigDecimal allocated

The total amount allocated via deposits and credit limits.
private Set allocations

(Allocation collection) Allocations associated with this fund.
private BigDecimal amount

The sum of active allocation amounts within this fund.

private BigDecimal available

The total amount available for charging.
private BigDecimal balance

The allocation total not blocked by reservations.
private Date creationTime

Date this fund was created.
private BigDecimal creditLimit

The sum of active credit limits within this fund.
private BigDecimal deposited

The total amount deposited in active allocations.

private String description

The fund description.
private Set fundConstraints

(FundConstraint collection) Constraints on fund usage.
private Long id

The unique fund identifier.
private Date modificationTime

The date this fund was last modified.
private String name

The name of this fund.
private Double percentRemaining

The percentage of allocation remaining.
private Double percentUsed

The percentage of allocated used.
private BigDecimal reserved

The sum of active reservation amounts against this fund.
private BigDecimal used

The total amount used this allocation cycle.
 
Constructor Summary
FundBalance()

 
Method Summary
BigDecimal getAllocated()

The total amount allocated via deposits and credit limits.
Set getAllocations()

(Allocation collection) Allocations associated with this fund.
BigDecimal getAmount()

The sum of active allocation amounts within this fund.

BigDecimal getAvailable()

The total amount available for charging.
BigDecimal getBalance()

The allocation total not blocked by reservations.
Date getCreationTime()

Date this fund was created.
BigDecimal getCreditLimit()

The sum of active credit limits within this fund.
BigDecimal getDeposited()

The total amount deposited in active allocations.

String getDescription()

The fund description.
Set getFundConstraints()

(FundConstraint collection) Constraints on fund usage.
Long getId()

The unique fund identifier.
Date getModificationTime()

The date this fund was last modified.
String getName()

The name of this fund.
Double getPercentRemaining()

The percentage of allocation remaining.
Double getPercentUsed()

The percentage of allocated used.
BigDecimal getReserved()

The sum of active reservation amounts against this fund.
BigDecimal getUsed()

The total amount used this allocation cycle.
void setAllocated(BigDecimal allocated)

The total amount allocated via deposits and credit limits.
void setAllocations(Set allocations)

(Allocation collection) Allocations associated with this fund.
void setAmount(BigDecimal amount)

The sum of active allocation amounts within this fund.

void setAvailable(BigDecimal available)

The total amount available for charging.
void setBalance(BigDecimal balance)

The allocation total not blocked by reservations.
void setCreationTime(Date creationTime)

Date this fund was created.
void setCreditLimit(BigDecimal creditLimit)

The sum of active credit limits within this fund.
void setDeposited(BigDecimal deposited)

The total amount deposited in active allocations.

void setDescription(String description)

The fund description.
void setFundConstraints(Set fundConstraints)

(FundConstraint collection) Constraints on fund usage.
void setId(Long id)

The unique fund identifier.
void setModificationTime(Date modificationTime)

The date this fund was last modified.
void setName(String name)

The name of this fund.
void setPercentRemaining(Double percentRemaining)

The percentage of allocation remaining.
void setPercentUsed(Double percentUsed)

The percentage of allocated used.
void setReserved(BigDecimal reserved)

The sum of active reservation amounts against this fund.
void setUsed(BigDecimal used)

The total amount used this allocation cycle.
String toString()

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

allocated

private BigDecimal allocated
The total amount allocated via deposits and credit limits.
deposited + creditLimit

allocations

private Set allocations
(Allocation collection) Allocations associated with this fund.
See Also:
Allocation

amount

private BigDecimal amount
The sum of active allocation amounts within this fund. It does not take into fund current reservations.

available

private BigDecimal available
The total amount available for charging.
amount - reserved + creditLimit

balance

private BigDecimal balance
The allocation total not blocked by reservations.
amount - reserved

creationTime

private Date creationTime
Date this fund was created.

creditLimit

private BigDecimal creditLimit
The sum of active credit limits within this fund.

deposited

private BigDecimal deposited
The total amount deposited in active allocations. This value is affected positively by deposits, activations and destination transfers and affected negatively by withdrawals, deactivations and source transfers that have occurred since the last reset.

description

private String description
The fund description.

fundConstraints

private Set fundConstraints
(FundConstraint collection) Constraints on fund usage.
See Also:
FundConstraint

id

private Long id
The unique fund identifier.

modificationTime

private Date modificationTime
The date this fund was last modified.

name

private String name
The name of this fund.

percentRemaining

private Double percentRemaining
The percentage of allocation remaining.
amount * 100 / deposited

percentUsed

private Double percentUsed
The percentage of allocated used.
used * 100 / deposited

reserved

private BigDecimal reserved
The sum of active reservation amounts against this fund.

used

private BigDecimal used
The total amount used this allocation cycle.
deposited - amount

 
Constructor Detail

FundBalance

FundBalance()

 
Method Detail

getAllocated

BigDecimal getAllocated()
The total amount allocated via deposits and credit limits.
deposited + creditLimit

getAllocations

Set getAllocations()
(Allocation collection) Allocations associated with this fund.
See Also:
Allocation

getAmount

BigDecimal getAmount()
The sum of active allocation amounts within this fund. It does not take into fund current reservations.

getAvailable

BigDecimal getAvailable()
The total amount available for charging.
amount - reserved + creditLimit

getBalance

BigDecimal getBalance()
The allocation total not blocked by reservations.
amount - reserved

getCreationTime

Date getCreationTime()
Date this fund was created.

getCreditLimit

BigDecimal getCreditLimit()
The sum of active credit limits within this fund.

getDeposited

BigDecimal getDeposited()
The total amount deposited in active allocations. This value is affected positively by deposits, activations and destination transfers and affected negatively by withdrawals, deactivations and source transfers that have occurred since the last reset.

getDescription

String getDescription()
The fund description.

getFundConstraints

Set getFundConstraints()
(FundConstraint collection) Constraints on fund usage.
See Also:
FundConstraint

getId

Long getId()
The unique fund identifier.

getModificationTime

Date getModificationTime()
The date this fund was last modified.

getName

String getName()
The name of this fund.

getPercentRemaining

Double getPercentRemaining()
The percentage of allocation remaining.
amount * 100 / deposited

getPercentUsed

Double getPercentUsed()
The percentage of allocated used.
used * 100 / deposited

getReserved

BigDecimal getReserved()
The sum of active reservation amounts against this fund.

getUsed

BigDecimal getUsed()
The total amount used this allocation cycle.
deposited - amount

setAllocated

void setAllocated(BigDecimal allocated)
The total amount allocated via deposits and credit limits.
deposited + creditLimit

setAllocations

void setAllocations(Set allocations)
(Allocation collection) Allocations associated with this fund.
See Also:
Allocation

setAmount

void setAmount(BigDecimal amount)
The sum of active allocation amounts within this fund. It does not take into fund current reservations.

setAvailable

void setAvailable(BigDecimal available)
The total amount available for charging.
amount - reserved + creditLimit

setBalance

void setBalance(BigDecimal balance)
The allocation total not blocked by reservations.
amount - reserved

setCreationTime

void setCreationTime(Date creationTime)
Date this fund was created.

setCreditLimit

void setCreditLimit(BigDecimal creditLimit)
The sum of active credit limits within this fund.

setDeposited

void setDeposited(BigDecimal deposited)
The total amount deposited in active allocations. This value is affected positively by deposits, activations and destination transfers and affected negatively by withdrawals, deactivations and source transfers that have occurred since the last reset.

setDescription

void setDescription(String description)
The fund description.

setFundConstraints

void setFundConstraints(Set fundConstraints)
(FundConstraint collection) Constraints on fund usage.
See Also:
FundConstraint

setId

void setId(Long id)
The unique fund identifier.

setModificationTime

void setModificationTime(Date modificationTime)
The date this fund was last modified.

setName

void setName(String name)
The name of this fund.

setPercentRemaining

void setPercentRemaining(Double percentRemaining)
The percentage of allocation remaining.
amount * 100 / deposited

setPercentUsed

void setPercentUsed(Double percentUsed)
The percentage of allocated used.
used * 100 / deposited

setReserved

void setReserved(BigDecimal reserved)
The sum of active reservation amounts against this fund.

setUsed

void setUsed(BigDecimal used)
The total amount used this allocation cycle.
deposited - amount

toString

String toString()

 

Groovy Documentation