Package cdm.product.common.settlement

Interface Cashflow

All Superinterfaces:

com.rosetta.model.lib.GlobalKey, PayoutBase, com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

Cashflow.CashflowBuilder

All Known Implementing Classes:

Cashflow.CashflowBuilderImpl, Cashflow.CashflowImpl

@RosettaDataType(value="Cashflow",
                 builder=CashflowBuilderImpl.class,
                 version="5.30.0")
@RuneDataType(value="Cashflow",
              model="cdm",
              builder=CashflowBuilderImpl.class,
              version="5.30.0")
public interface Cashflow
extends PayoutBase, com.rosetta.model.lib.GlobalKey

Class to specify a cashflow, i.e. the outcome of either of computation (e.g. interest accrual) or an assessment of some sort (e.g. a fee). The cashflow can then be turned into a cash transfer, artefact to be used as the input to a payment system or the outcome of it. The associated globalKey denotes the ability to associate a hash value to the Cashflow instantiations for the purpose of model cross-referencing, in support of functionality such as the event effect and the lineage.

Version:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Cashflow.CashflowBuilder	Builder Interface
static class	Cashflow.CashflowBuilderImpl	Builder Implementation of Cashflow
static class	Cashflow.CashflowImpl	Immutable Implementation of Cashflow

Nested classes/interfaces inherited from interface com.rosetta.model.lib.GlobalKey

com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Nested classes/interfaces inherited from interface cdm.product.common.settlement.PayoutBase

PayoutBase.PayoutBaseBuilder, PayoutBase.PayoutBaseBuilderImpl, PayoutBase.PayoutBaseImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final CashflowMeta	metaData

Method Summary

Modifier and Type	Method	Description
Cashflow	build()	Build Methods
static Cashflow.CashflowBuilder	builder()
CashflowType	getCashflowType()	The qualification of the type of cashflow, e.g. brokerage fee, premium, upfront fee etc.
com.rosetta.model.metafields.MetaFields	getMeta()
PaymentDiscounting	getPaymentDiscounting()	FpML specifies the FpML PaymentDiscounting.model group for representing the discounting elements that can be associated with a payment.
default Class<? extends Cashflow>	getType()
default com.rosetta.model.lib.meta.RosettaMetaData<? extends Cashflow>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
Cashflow.CashflowBuilder	toBuilder()

Methods inherited from interface cdm.product.common.settlement.PayoutBase

getPayerReceiver, getPriceQuantity, getPrincipalPayment, getSettlementTerms

Methods inherited from interface com.rosetta.model.lib.RosettaModelObject

processRosetta, processRosetta

Field Details

metaData

static final CashflowMeta metaData

Method Details

getCashflowType

CashflowType getCashflowType()

The qualification of the type of cashflow, e.g. brokerage fee, premium, upfront fee etc. Particularly relevant when it cannot be inferred directly through lineage.

getPaymentDiscounting

PaymentDiscounting getPaymentDiscounting()

FpML specifies the FpML PaymentDiscounting.model group for representing the discounting elements that can be associated with a payment.

getMeta

com.rosetta.model.metafields.MetaFields getMeta()

Specified by:

getMeta in interface com.rosetta.model.lib.GlobalKey

build

Cashflow build()

Build Methods

Specified by:

build in interface PayoutBase

Specified by:

build in interface com.rosetta.model.lib.RosettaModelObject

toBuilder

Cashflow.CashflowBuilder toBuilder()

Specified by:

toBuilder in interface PayoutBase

Specified by:

toBuilder in interface com.rosetta.model.lib.RosettaModelObject

builder

static Cashflow.CashflowBuilder builder()

metaData

default com.rosetta.model.lib.meta.RosettaMetaData<? extends Cashflow> metaData()

Utility Methods

Specified by:

metaData in interface PayoutBase

Specified by:

metaData in interface com.rosetta.model.lib.RosettaModelObject

getType

@RuneAttribute("@type")
default Class<? extends Cashflow> getType()

Specified by:

getType in interface PayoutBase

Specified by:

getType in interface com.rosetta.model.lib.RosettaModelObject

process

default void process(com.rosetta.model.lib.path.RosettaPath path,
 com.rosetta.model.lib.process.Processor processor)

Specified by:

process in interface PayoutBase

Specified by:

process in interface com.rosetta.model.lib.RosettaModelObject