Package org.isda.cdm
Class CashSettlementTerms
- java.lang.Object
-
- com.rosetta.model.lib.RosettaModelObject
-
- org.isda.cdm.SettlementBase
-
- org.isda.cdm.CashSettlementTerms
-
- All Implemented Interfaces:
com.rosetta.model.lib.GlobalKey
@RosettaClass @RosettaSynonym(value="CashSettlementTerms", source="FpML_5_10") public class CashSettlementTerms extends SettlementBase
In FpML, PhysicalSettlementTerms and CashSettlementTerms extend SettlementTerms. In the CDM, this extension paradigm has not been used because SettlementTerms class has been used for purposes related to securities transactions, while it is not used as such in the FpML standard (i.e. only as an abstract construct.- Version:
- 2.5.4
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CashSettlementTerms.CashSettlementTermsBuilder
-
Nested classes/interfaces inherited from class org.isda.cdm.SettlementBase
SettlementBase.SettlementBaseBuilder
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CashSettlementTerms.CashSettlementTermsBuilder
builder()
boolean
equals(java.lang.Object o)
java.lang.Boolean
getAccruedInterest()
Indicates whether accrued interest is included (true) or not (false).Money
getCashSettlementAmount()
The amount paid by the seller to the buyer for cash settlement on the cash settlement date.java.lang.Integer
getCashSettlementBusinessDays()
The number of business days used in the determination of the cash settlement payment date.java.lang.String
getDealer()
A dealer from whom quotations are obtained by the calculation agent on the reference obligation for purposes of cash settlement.java.lang.Boolean
getFixedSettlement()
Used for Recovery Lock, to indicate whether fixed Settlement is Applicable or Not Applicable.Money
getMinimumQuotationAmout()
In the determination of a cash settlement amount, if weighted average quotations are to be obtained, the minimum quotation amount specifies a minimum intended threshold amount of outstanding principal balance of the reference obligation for which the quote should be obtained.Money
getQuotationAmount()
In the determination of a cash settlement amount, if weighted average quotations are to be obtained, the quotation amount specifies an upper limit to the outstanding principal balance of the reference obligation for which the quote should be obtained.QuotationRateTypeEnum
getQuotationMethod()
The type of price quotations to be requested from dealers when determining the market value of the reference obligation for purposes of cash settlement.java.math.BigDecimal
getRecoveryFactor()
Used for fixed recovery, specifies the recovery level, determined at contract inception, to be applied on a default.ValuationDate
getValuationDate()
The number of business days after conditions to settlement have been satisfied when the calculation agent obtains a price quotation on the Reference Obligation for purposes of cash settlement.ValuationMethodEnum
getValuationMethod()
The ISDA defined methodology for determining the final price of the reference obligation for purposes of cash settlement.BusinessCenterTime
getValuationTime()
The time of day in the specified business center when the calculation agent seeks quotations for an amount of the reference obligation for purposes of cash settlement.int
hashCode()
com.rosetta.model.lib.meta.RosettaMetaData<? extends CashSettlementTerms>
metaData()
void
process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
CashSettlementTerms.CashSettlementTermsBuilder
toBuilder()
java.lang.String
toString()
-
Methods inherited from class org.isda.cdm.SettlementBase
getMeta, getSettlementCurrency
-
-
-
-
Method Detail
-
getAccruedInterest
@RosettaSynonym(value="accruedInterest",source="FpML_5_10") @RosettaSynonym(value="accruedInterest",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="accruedInterest",source="DTCC_11_0") @RosettaSynonym(value="accruedInterest",source="DTCC_9_0") @RosettaSynonym(value="accruedInterest",source="CME_ClearedConfirm_1_17") public final java.lang.Boolean getAccruedInterest()
Indicates whether accrued interest is included (true) or not (false). For cash settlement this specifies whether quotations should be obtained inclusive or not of accrued interest. For physical settlement this specifies whether the buyer should deliver the obligation with an outstanding principal balance that includes or excludes accrued interest. ISDA 2003 Term: Include/Exclude Accrued Interest.
-
getCashSettlementAmount
@RosettaSynonym(value="cashSettlementAmount",source="FpML_5_10") @RosettaSynonym(value="cashSettlementAmount",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="cashSettlementAmount",source="DTCC_11_0") @RosettaSynonym(value="cashSettlementAmount",source="DTCC_9_0") @RosettaSynonym(value="cashSettlementAmount",source="CME_ClearedConfirm_1_17") public final Money getCashSettlementAmount()
The amount paid by the seller to the buyer for cash settlement on the cash settlement date. If not otherwise specified, would typically be calculated as 100 (or the Reference Price) minus the price of the Reference Obligation (all expressed as a percentage) times Floating Rate Payer Calculation Amount. ISDA 2003 Term: Cash Settlement Amount.
-
getCashSettlementBusinessDays
@RosettaSynonym(value="cashSettlementBusinessDays",source="FpML_5_10") @RosettaSynonym(value="cashSettlementBusinessDays",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="cashSettlementBusinessDays",source="DTCC_11_0") @RosettaSynonym(value="cashSettlementBusinessDays",source="DTCC_9_0") @RosettaSynonym(value="cashSettlementBusinessDays",source="CME_ClearedConfirm_1_17") public final java.lang.Integer getCashSettlementBusinessDays()
The number of business days used in the determination of the cash settlement payment date. If a cash settlement amount is specified, the cash settlement payment date will be this number of business days following the calculation of the final price. If a cash settlement amount is not specified, the cash settlement payment date will be this number of business days after all conditions to settlement are satisfied. ISDA 2003 Term: Cash Settlement Date.
-
getDealer
@RosettaSynonym(value="dealer",source="FpML_5_10") @RosettaSynonym(value="dealer",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="dealer",source="DTCC_11_0") @RosettaSynonym(value="dealer",source="DTCC_9_0") @RosettaSynonym(value="dealer",source="CME_ClearedConfirm_1_17") public final java.lang.String getDealer()
A dealer from whom quotations are obtained by the calculation agent on the reference obligation for purposes of cash settlement. ISDA 2003 Term: Dealer.
-
getFixedSettlement
@RosettaSynonym(value="fixedSettlement",source="FpML_5_10") @RosettaSynonym(value="fixedSettlement",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="fixedSettlement",source="DTCC_11_0") @RosettaSynonym(value="fixedSettlement",source="DTCC_9_0") @RosettaSynonym(value="fixedSettlement",source="CME_ClearedConfirm_1_17") public final java.lang.Boolean getFixedSettlement()
Used for Recovery Lock, to indicate whether fixed Settlement is Applicable or Not Applicable. If Buyer fails to deliver an effective Notice of Physical Settlement on or before the Buyer NOPS Cut-off Date, and if Seller fails to deliver an effective Seller NOPS on or before the Seller NOPS Cut-off Date, then either: (a) if Fixed Settlement is specified in the related Confirmation as not applicable, then the Seller NOPS Cut-off Date shall be the Termination Date; or (b) if Fixed Settlement is specified in the related Confirmation as applicable, then: (i) if the Fixed Settlement Amount is a positive number, Seller shall, subject to Section 3.1 (except for the requirement of satisfaction of the Notice of Physical Settlement Condition to Settlement), pay the Fixed Settlement Amount to Buyer on the Fixed Settlement Payment Date; and (ii) if the Fixed Settlement Amount is a negative number, Buyer shall, subject to Section 3.1 (except for the requirement of satisfaction of the Notice of Physical Settlement Condition to Settlement), pay the absolute value of the Fixed Settlement Amount to Seller on the Fixed Settlement Payment Date.
-
getMinimumQuotationAmout
@RosettaSynonym(value="minimumQuotationAmount",source="FpML_5_10") @RosettaSynonym(value="minimumQuotationAmount",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="minimumQuotationAmount",source="DTCC_11_0") @RosettaSynonym(value="minimumQuotationAmount",source="DTCC_9_0") @RosettaSynonym(value="minimumQuotationAmount",source="CME_ClearedConfirm_1_17") public final Money getMinimumQuotationAmout()
In the determination of a cash settlement amount, if weighted average quotations are to be obtained, the minimum quotation amount specifies a minimum intended threshold amount of outstanding principal balance of the reference obligation for which the quote should be obtained. If not specified, the ISDA definitions provide for a fallback amount of the lower of either USD 1,000,000 (or its equivalent in the relevant obligation currency) or the quotation amount. ISDA 2003 Term: Minimum Quotation Amount.
-
getQuotationAmount
@RosettaSynonym(value="quotationAmount",source="FpML_5_10") @RosettaSynonym(value="quotationAmount",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="quotationAmount",source="DTCC_11_0") @RosettaSynonym(value="quotationAmount",source="DTCC_9_0") @RosettaSynonym(value="quotationAmount",source="CME_ClearedConfirm_1_17") public final Money getQuotationAmount()
In the determination of a cash settlement amount, if weighted average quotations are to be obtained, the quotation amount specifies an upper limit to the outstanding principal balance of the reference obligation for which the quote should be obtained. If not specified, the ISDA definitions provide for a fallback amount equal to the floating rate payer calculation amount. ISDA 2003 Term: Quotation Amount.
-
getQuotationMethod
@RosettaSynonym(value="quotationMethod",source="FpML_5_10") @RosettaSynonym(value="quotationMethod",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="quotationMethod",source="DTCC_11_0") @RosettaSynonym(value="quotationMethod",source="DTCC_9_0") @RosettaSynonym(value="quotationMethod",source="CME_ClearedConfirm_1_17") public final QuotationRateTypeEnum getQuotationMethod()
The type of price quotations to be requested from dealers when determining the market value of the reference obligation for purposes of cash settlement. For example, Bid, Offer or Mid-market. ISDA 2003 Term: Quotation Method.
-
getRecoveryFactor
@RosettaSynonym(value="recoveryFactor",source="FpML_5_10") @RosettaSynonym(value="recoveryFactor",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="recoveryFactor",source="DTCC_11_0") @RosettaSynonym(value="recoveryFactor",source="DTCC_9_0") @RosettaSynonym(value="recoveryFactor",source="CME_ClearedConfirm_1_17") public final java.math.BigDecimal getRecoveryFactor()
Used for fixed recovery, specifies the recovery level, determined at contract inception, to be applied on a default. Used to calculate the amount paid by the seller to the buyer for cash settlement on the cash settlement date. Amount calculation is (1 minus the Recovery Factor) multiplied by the Floating Rate Payer Calculation Amount. The currency will be derived from the Floating Rate Payer Calculation Amount.
-
getValuationDate
@RosettaSynonym(value="valuationDate",source="FpML_5_10") @RosettaSynonym(value="valuationDate",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="valuationDate",source="DTCC_11_0") @RosettaSynonym(value="valuationDate",source="DTCC_9_0") @RosettaSynonym(value="valuationDate",source="CME_ClearedConfirm_1_17") public final ValuationDate getValuationDate()
The number of business days after conditions to settlement have been satisfied when the calculation agent obtains a price quotation on the Reference Obligation for purposes of cash settlement. There may be one or more valuation dates. This is typically specified if the cash settlement amount is not a fixed amount. ISDA 2003 Term: Valuation Date.
-
getValuationMethod
@RosettaSynonym(value="valuationMethod",source="FpML_5_10") @RosettaSynonym(value="valuationMethod",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="valuationMethod",source="DTCC_11_0") @RosettaSynonym(value="valuationMethod",source="DTCC_9_0") @RosettaSynonym(value="valuationMethod",source="CME_ClearedConfirm_1_17") public final ValuationMethodEnum getValuationMethod()
The ISDA defined methodology for determining the final price of the reference obligation for purposes of cash settlement. (ISDA 2003 Term: Valuation Method). For example, Market, Highest etc.
-
getValuationTime
@RosettaSynonym(value="valuationTime",source="FpML_5_10") @RosettaSynonym(value="valuationTime",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="valuationTime",source="DTCC_11_0") @RosettaSynonym(value="valuationTime",source="DTCC_9_0") @RosettaSynonym(value="valuationTime",source="CME_ClearedConfirm_1_17") public final BusinessCenterTime getValuationTime()
The time of day in the specified business center when the calculation agent seeks quotations for an amount of the reference obligation for purposes of cash settlement. ISDA 2003 Term: Valuation Time.
-
metaData
public com.rosetta.model.lib.meta.RosettaMetaData<? extends CashSettlementTerms> metaData()
- Overrides:
metaData
in classSettlementBase
-
toBuilder
public CashSettlementTerms.CashSettlementTermsBuilder toBuilder()
- Overrides:
toBuilder
in classSettlementBase
-
builder
public static CashSettlementTerms.CashSettlementTermsBuilder builder()
-
process
public void process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
- Overrides:
process
in classSettlementBase
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classSettlementBase
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classSettlementBase
-
toString
public java.lang.String toString()
- Overrides:
toString
in classSettlementBase
-
-