Package org.isda.cdm

Class TransferPrimitive

  • All Implemented Interfaces:
    com.rosetta.model.lib.GlobalKey

    @RosettaClass
    public class TransferPrimitive
    extends com.rosetta.model.lib.RosettaModelObject
    implements com.rosetta.model.lib.GlobalKey
    A class to specify the transfer of assets between parties, those assets being either cash, securities or physical assets. This class combines components that are cross-assets (settlement date, settlement type, status, ...) and some other which are specialized by asset class (e.g. the payer/receiver amount and cashflow type for a cash transfer, the transferor/transferee, security indication, quantity, and asset transfer type qualification for the case of a security). The associated rosettaKey denotes the ability to associate a hash value to the respective Execution instantiations for the purpose of model cross-referencing, in support of functionality such as the event effect and the lineage.
    Version:
    2.5.4
    • Method Detail

      • getCashTransfer

        @RosettaSynonym(value="cashTransfer",source="Rosetta_Workbench") @RosettaSynonym(value="payment",source="DTCC_11_0",path="FpML") @RosettaSynonym(value="payment",source="DTCC_9_0",path="FpML")
        public final java.util.List<CashTransferComponent> getCashTransfer()
        The cash transfer component of the transfer. In the case where several currencies are involved in the transfer, several components should be used, as the component supports one single currency amount.
      • getIdentifier

        @RosettaSynonym(value="tradeCashflowsId",source="DTCC_11_0",path="FpML") @RosettaSynonym(value="tradeCashflowsId",source="DTCC_9_0",path="FpML")
        public final FieldWithMetaString getIdentifier()
        The identifier which might be associated with the transfer.
      • getMeta

        public final MetaFields getMeta()
        Specified by:
        getMeta in interface com.rosetta.model.lib.GlobalKey
      • getSecurityTransfer

        @RosettaSynonym(value="securityTransfer",
                        source="Rosetta_Workbench")
        public final java.util.List<SecurityTransferComponent> getSecurityTransfer()
        The security transfer component of the transfer. In the case where several securities are involved in the transfer, several components should be used, as the component supports one single security.
      • getSettlementReference

        @RosettaSynonym(value="settlementReference",
                        source="Rosetta_Workbench")
        public final java.lang.String getSettlementReference()
        The settlement reference, when applicable.
      • getSettlementType

        @RosettaSynonym(value="transferType",source="Rosetta_Workbench") @RosettaSynonym(value="SettlementType",source="DTCC_11_0",path="PaymentDetails") @RosettaSynonym(value="SettlementType",source="DTCC_9_0",path="PaymentDetails")
        public final TransferSettlementEnum getSettlementType()
        The qualification as to how the transfer will settle, e.g. a DvP settlement.
      • getStatus

        @RosettaSynonym(value="status",
                        source="Rosetta_Workbench")
        public final TransferStatusEnum getStatus()
        The transfer status, e.g. Instructed, Settled, ...
      • metaData

        public com.rosetta.model.lib.meta.RosettaMetaData<? extends TransferPrimitive> metaData()
        Specified by:
        metaData in class com.rosetta.model.lib.RosettaModelObject
      • process

        public void process​(com.rosetta.model.lib.path.RosettaPath path,
                            com.rosetta.model.lib.process.Processor processor)
        Specified by:
        process in class com.rosetta.model.lib.RosettaModelObject
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object