public final class ProratedFacility extends Object implements ProratedProduct, org.joda.beans.ImmutableBean
Modifier and Type | Class and Description |
---|---|
static class |
ProratedFacility.Builder
The bean-builder for
ProratedFacility . |
static class |
ProratedFacility.Meta
The meta-bean for
ProratedFacility . |
Modifier and Type | Method and Description |
---|---|
static ProratedFacility.Builder |
builder()
Returns a builder used to create an instance of the bean.
|
boolean |
equals(Object obj) |
com.opengamma.strata.basics.StandardId |
getAgent()
Gets the agent identifier, optional.
|
com.opengamma.strata.basics.StandardId |
getBorrower()
Gets the borrower identifier
|
com.opengamma.strata.collect.timeseries.LocalDateDoubleTimeSeries |
getCommitment()
Gets given total commitment schedule for this loan.
|
double |
getCommitmentAmount(java.time.LocalDate date)
Return the global commitment amount as of a specific date
|
com.google.common.collect.ImmutableList<ProratedLoanContract> |
getContracts()
Gets the interest paying contracts of the facility.
|
com.opengamma.strata.basics.currency.Currency |
getCurrency()
Gets the primary currency.
|
com.google.common.collect.ImmutableList<ProratedLoanEvent> |
getEvents()
Gets events (CommitmentAdjustment) associated with this loan.
|
FacilityType |
getFacilityType()
Gets the type of this facility.
|
com.google.common.collect.ImmutableList<ProratedAccruingFee> |
getFees()
Gets the accruing fees of the facility.
|
double |
getFundedAmount(java.time.LocalDate date)
Return the prorated funded amount as of a specific date by
simply summing the prorated amount of each active contract on that date,
accounting for any repayments.
|
com.opengamma.strata.basics.StandardId |
getId()
Gets unique loan identifier.
|
com.google.common.collect.ImmutableList<com.opengamma.strata.basics.StandardId> |
getIdentifiers()
Gets the identifiers of this facility.
|
java.time.LocalDate |
getMaturityDate()
Gets the maturity date of this facility.
|
java.time.LocalDate |
getStartDate()
Gets the funding date of this facility.
|
double |
getUnfundedAmount(java.time.LocalDate date)
Return the prorated unfunded amount as of a specific date.
|
int |
hashCode() |
static ProratedFacility.Meta |
meta()
The meta-bean for
ProratedFacility . |
ProratedFacility.Meta |
metaBean() |
ProratedFacility.Builder |
toBuilder()
Returns a builder that allows this bean to be mutated.
|
String |
toString() |
public double getFundedAmount(java.time.LocalDate date)
date
- to return funded amount.public double getUnfundedAmount(java.time.LocalDate date)
date
- to return funded amount.public double getCommitmentAmount(java.time.LocalDate date)
date
- to return commitment amount.public static ProratedFacility.Meta meta()
ProratedFacility
.public static ProratedFacility.Builder builder()
public ProratedFacility.Meta metaBean()
metaBean
in interface org.joda.beans.Bean
public com.opengamma.strata.basics.StandardId getId()
A public (e.g. LXID) or internal id which uniquely identifies a loan facility.
public com.opengamma.strata.basics.StandardId getBorrower()
An identifier used to specify the borrower of the facility.
public com.opengamma.strata.basics.StandardId getAgent()
An identifier used to specify the agent of the facility.
public FacilityType getFacilityType()
public com.google.common.collect.ImmutableList<com.opengamma.strata.basics.StandardId> getIdentifiers()
public java.time.LocalDate getStartDate()
Funds may be drawn from this date.
public java.time.LocalDate getMaturityDate()
Date on which final principal and interest is repaid.
public com.opengamma.strata.basics.currency.Currency getCurrency()
This is the currency of the loan and the currency that payment is made in.
public com.opengamma.strata.collect.timeseries.LocalDateDoubleTimeSeries getCommitment()
public com.google.common.collect.ImmutableList<ProratedLoanContract> getContracts()
A loan facility may have of zero or more contracts.
public com.google.common.collect.ImmutableList<ProratedAccruingFee> getFees()
A loan facility may have of zero or more accruing fees.
public com.google.common.collect.ImmutableList<ProratedLoanEvent> getEvents()
A loan may have of zero or more events.
public ProratedFacility.Builder toBuilder()
Copyright © 2018. All rights reserved.