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

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

class Fund

An fund is a container for a time-bounded reference currency called credits for which the usage is restricted by constraints that define how the credits must be used. Much like with a bank, an fund is a repository for these resource or service credits which are added through deposits and debited through withdrawals and charges. Each fund has a set of constraints designating which entities (such as Users, Accounts, Machines, Classes, Organizations, etc.) may access the fund or for which aspects of usage the funds are intended (QualityOfService, GeographicalArea, Feature, etc.). Fund constraints may also be negated with an exclamation point leading the constraint value.

When credits are deposited into an fund, they are associated with a time period within which they are valid. These time-bounded pools of credits are known as allocations. (An allocation is a pool of billable units associated with an fund for use during a particular time period.) By using multiple allocations that expire in regular intervals it is possible to implement a use-it-or-lose-it policy and establish an allocation cycle.

Funds may be nested. Hierarchically nested funds may be useful for the delegation of management roles and responsibilities. Deposit shares may be established that assist to automate a trickle-down effect for funds deposited at higher level funds. Additionally, an optional overflow feature allows charges against lower level funds to trickle up the hierarchy.

Funds may have an arbitrary name which is not necessarily unique for the fund. Funds may also have a priority which will influence the order of fund selection when charging.

Authors:

bsaville

allocations

private Set allocations

(Allocation collection) The 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 liens.

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.

priority

private Integer priority

The fund priority.

Fund

Fund()

getAllocations

Set getAllocations()

(Allocation collection) The 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 liens.

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.

getPriority

Integer getPriority()

The fund priority.

setAllocations

void setAllocations(Set allocations)

(Allocation collection) The 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 liens.

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.

setPriority

void setPriority(Integer priority)

The fund priority.

toString

String toString()

Groovy Documentation