com.ace.mws.mam.Allocation
|
Groovy Documentation | |||||||
| FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Object
class Allocation
An allocation is a time-bounded pool of resource or service credits associated with an fund. An fund may have multiple allocations, each for use during a different time period.
An allocation has a start time and an end time that defines the time period during which the allocation may be used. By default an allocation is created with an unbounded time period (-infinity to infinity). An active flag is automatically updated to true if the fund is within its valid timeframe or false if it is not. An allocation may also have a credit limit representing the amount by which it can go negative. Thus, by having a positive balance in the Amount field, the fund is like a debit fund, implementing a pay-first use-later model. By establishing a credit limit instead of depositing an initial balance, the fund will be like a credit fund, implementing a use-first pay-later model. These strategies can be combined by depositing some amount of funds coupled with a credit limit, implementing a form of overdraft protection where the funds will be used down to the negative of the credit limit.
| Field Summary | |
|---|---|
private Boolean |
active
Indicates whether this allocation is active or not. |
private BigDecimal |
amount
The amount of this allocation. |
private Date |
creationTime
The date this allocation was created. |
private BigDecimal |
creditLimit
Determines how far in the negative this allocation is permitted to be used (enforced in quotes and reservations). |
private BigDecimal |
deposited
The total amount deposited this allocation cycle. |
private String |
description
The description of this allocation. |
private Date |
endTime
The date this allocation becomes inactive. |
private String |
fundId
The fund ID associated with this allocation. |
private String |
id
The unique identifier for this allocation. |
private Date |
modificationTime
The date this allocation was last modified. |
private Date |
startTime
The date this allocation becomes active. |
| Constructor Summary | |
Allocation()
|
|
| Method Summary | |
|---|---|
Boolean
|
getActive()
Indicates whether this allocation is active or not. |
BigDecimal
|
getAmount()
The amount of this allocation. |
Date
|
getCreationTime()
The date this allocation was created. |
BigDecimal
|
getCreditLimit()
Determines how far in the negative this allocation is permitted to be used (enforced in quotes and reservations). |
BigDecimal
|
getDeposited()
The total amount deposited this allocation cycle. |
String
|
getDescription()
The description of this allocation. |
Date
|
getEndTime()
The date this allocation becomes inactive. |
String
|
getFundId()
The fund ID associated with this allocation. |
String
|
getId()
The unique identifier for this allocation. |
Date
|
getModificationTime()
The date this allocation was last modified. |
Date
|
getStartTime()
The date this allocation becomes active. |
void
|
setActive(Boolean active)
Indicates whether this allocation is active or not. |
void
|
setAmount(BigDecimal amount)
The amount of this allocation. |
void
|
setCreationTime(Date creationTime)
The date this allocation was created. |
void
|
setCreditLimit(BigDecimal creditLimit)
Determines how far in the negative this allocation is permitted to be used (enforced in quotes and reservations). |
void
|
setDeposited(BigDecimal deposited)
The total amount deposited this allocation cycle. |
void
|
setDescription(String description)
The description of this allocation. |
void
|
setEndTime(Date endTime)
The date this allocation becomes inactive. |
void
|
setFundId(String fundId)
The fund ID associated with this allocation. |
void
|
setId(String id)
The unique identifier for this allocation. |
void
|
setModificationTime(Date modificationTime)
The date this allocation was last modified. |
void
|
setStartTime(Date startTime)
The date this allocation becomes active. |
String
|
toString()
|
| Methods inherited from class Object | |
|---|---|
| wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
| Field Detail |
|---|
private Boolean active
private BigDecimal amount
private Date creationTime
private BigDecimal creditLimit
private BigDecimal deposited
private String description
private Date endTime
private String fundId
private String id
private Date modificationTime
private Date startTime
| Constructor Detail |
|---|
Allocation()
| Method Detail |
|---|
Boolean getActive()
BigDecimal getAmount()
Date getCreationTime()
BigDecimal getCreditLimit()
BigDecimal getDeposited()
String getDescription()
Date getEndTime()
String getFundId()
String getId()
Date getModificationTime()
Date getStartTime()
void setActive(Boolean active)
void setAmount(BigDecimal amount)
void setCreationTime(Date creationTime)
void setCreditLimit(BigDecimal creditLimit)
void setDeposited(BigDecimal deposited)
void setDescription(String description)
void setEndTime(Date endTime)
void setFundId(String fundId)
void setId(String id)
void setModificationTime(Date modificationTime)
void setStartTime(Date startTime)
String toString()
Groovy Documentation