Package org.isda.cdm

Class Contract

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

    @RosettaClass
    public class Contract
    extends com.rosetta.model.lib.RosettaModelObject
    implements com.rosetta.model.lib.GlobalKey
    A class to specify a financial contract object, which can be invoked either within the context of an event, or independently from it. It corresponds to the FpML Trade in the Confirmation view (while the CDM Execution class corresponds to the FpML trade in the Pre-Trade view). The associated rosettaKey denotes the ability to associate a hash value to the Contract 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

      • getAccount

        @RosettaSynonym(value="account",source="FpML_5_10") @RosettaSynonym(value="account",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="account",source="DTCC_11_0") @RosettaSynonym(value="account",source="DTCC_9_0")
        public final java.util.List<Account> getAccount()
        Optional account information.
      • getCalculationAgent

        public final CalculationAgent getCalculationAgent()
        The ISDA calculation agent responsible for performing duties as defined in the applicable product definitions.
      • getClearedDate

        @RosettaSynonym(value="clearedDate",source="FpML_5_10",path="trade.tradeHeader") @RosettaSynonym(value="clearedDate",source="DTCC_11_0",path="trade.tradeHeader") @RosettaSynonym(value="clearedDate",source="DTCC_9_0",path="trade.tradeHeader") @RosettaSynonym(value="clearedDate",source="CME_SubmissionIRS_1_0",path="trade.tradeHeader") @RosettaSynonym(value="clearedDate",source="CME_ClearedConfirm_1_17",path="trade.tradeHeader") @RosettaSynonym(value="clearedDate",source="FpML_5_10",path="tradeHeader") @RosettaSynonym(value="clearedDate",source="CME_ClearedConfirm_1_17",path="tradeHeader")
        public final com.rosetta.model.lib.records.Date getClearedDate()
        If the trade was cleared (novated) through a central counterparty clearing service, this represents the date the trade was cleared (transferred to the central counterparty).
      • getClosedState

        @RosettaSynonym(value="closedState",
                        source="Rosetta_Workbench")
        public final ClosedState getClosedState()
        The qualification of what led to the contract closure alongside with the dates on which this closure took effect.
      • getCollateral

        @RosettaSynonym(value="collateral",source="FpML_5_10",path="trade") @RosettaSynonym(value="collateral",source="DTCC_11_0",path="trade") @RosettaSynonym(value="collateral",source="DTCC_9_0",path="trade") @RosettaSynonym(value="collateral",source="CME_SubmissionIRS_1_0",path="trade") @RosettaSynonym(value="collateral",source="CME_ClearedConfirm_1_17",path="trade") @RosettaSynonym(value="collateral",source="FpML_5_10") @RosettaSynonym(value="collateral",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="collateral",source="CME_ClearedConfirm_1_17")
        public final Collateral getCollateral()
        Defines the collateral obligations of a party.
      • getContractIdentifier

        @RosettaSynonym(value="partyTradeIdentifier",source="FpML_5_10",path="trade.tradeHeader") @RosettaSynonym(value="partyTradeIdentifier",source="CME_SubmissionIRS_1_0",path="trade.tradeHeader") @RosettaSynonym(value="partyTradeIdentifier",source="FpML_5_10",path="tradeHeader") @RosettaSynonym(value="partyTradeIdentifier",source="CME_SubmissionIRS_1_0",path="tradeHeader") @RosettaSynonym(value="partyTradeIdentifier",source="CME_ClearedConfirm_1_17",path="trade.tradeHeader") @RosettaSynonym(value="universalSwapIdentifier",source="CME_ClearedConfirm_1_17",path="trade.tradeHeader") @RosettaSynonym(value="partyTradeIdentifier",source="CME_SubmissionIRS_1_0",path="Instrmt.SecXML.FpML.trade.tradeHeader") @RosettaSynonym(value="Submitter",source="DTCC_11_0") @RosettaSynonym(value="Submitter",source="DTCC_9_0") @RosettaSynonym(value="ContraTradeId",source="DTCC_11_0") @RosettaSynonym(value="ContraTradeId",source="DTCC_9_0") @RosettaSynonym(value="YourTradeId",source="DTCC_11_0") @RosettaSynonym(value="YourTradeId",source="DTCC_9_0") @RosettaSynonym(value="tradeIdentifyingItems",source="DTCC_11_0") @RosettaSynonym(value="tradeIdentifyingItems",source="DTCC_9_0") @RosettaSynonym(value="USI",source="DTCC_11_0") @RosettaSynonym(value="USI",source="DTCC_9_0") @RosettaSynonym(value="OriginatingUSI",source="DTCC_11_0") @RosettaSynonym(value="OriginatingUSI",source="DTCC_9_0") @RosettaSynonym(value="UTI",source="DTCC_11_0") @RosettaSynonym(value="UTI",source="DTCC_9_0")
        public final java.util.List<Identifier> getContractIdentifier()
        The identifier(s) that uniquely identify a contract, and which can be qualified by referencing or defining the issuer(s) of such identifier(s). There can be several contract identifier, an example of such being a contract is reportable to both the CFTC and ESMA and then has an associated USI (Unique Swap Identifier) UTI (Unique Trade Identifier).
      • getContractualProduct

        @RosettaSynonym(value="trade",
                        source="CME_SubmissionIRS_1_0",
                        path="Instrmt.SecXML.FpML")
        public final ContractualProduct getContractualProduct()
        The contractual product information that is associated with the contract, which combines the economic terms, the product identification and the product taxonomy. The corresponding FpML construct is the product abstract element and the associated substitution group.
      • getContractualQuantity

        @RosettaSynonym(value="returnLeg",source="FpML_5_10",path="trade.returnSwap") @RosettaSynonym(value="returnLeg",source="FpML_5_10",path="trade.equitySwapTransactionSupplement") @RosettaSynonym(value="swap",source="FpML_5_10",path="") @RosettaSynonym(value="swap",source="FpML_5_10",path="trade") @RosettaSynonym(value="swap",source="CME_SubmissionIRS_1_0",path="") @RosettaSynonym(value="swap",source="CME_SubmissionIRS_1_0",path="trade") @RosettaSynonym(value="swap",source="DTCC_11_0",path="") @RosettaSynonym(value="swap",source="DTCC_11_0",path="trade") @RosettaSynonym(value="swap",source="DTCC_9_0",path="") @RosettaSynonym(value="swap",source="DTCC_9_0",path="trade") @RosettaSynonym(value="swap",source="CME_ClearedConfirm_1_17",path="") @RosettaSynonym(value="swap",source="CME_ClearedConfirm_1_17",path="trade") @RosettaSynonym(value="swap",source="CME_SubmissionIRS_1_0",path="Instrmt.SecXML.FpML.trade") @RosettaSynonym(value="swap",source="FpML_5_10",path="trade.swaption") @RosettaSynonym(value="swap",source="CME_SubmissionIRS_1_0",path="trade.swaption") @RosettaSynonym(value="swap",source="DTCC_11_0",path="trade.swaption") @RosettaSynonym(value="swap",source="DTCC_9_0",path="trade.swaption") @RosettaSynonym(value="swap",source="CME_ClearedConfirm_1_17",path="trade.swaption") @RosettaSynonym(value="swap",source="FpML_5_10",path="swaption") @RosettaSynonym(value="swap",source="CME_SubmissionIRS_1_0",path="swaption") @RosettaSynonym(value="swap",source="DTCC_11_0",path="swaption") @RosettaSynonym(value="swap",source="DTCC_9_0",path="swaption") @RosettaSynonym(value="swap",source="CME_ClearedConfirm_1_17",path="swaption") @RosettaSynonym(value="capFloor",source="FpML_5_10",path="trade") @RosettaSynonym(value="capFloor",source="CME_SubmissionIRS_1_0",path="trade") @RosettaSynonym(value="capFloor",source="DTCC_11_0",path="trade") @RosettaSynonym(value="capFloor",source="DTCC_9_0",path="trade") @RosettaSynonym(value="capFloor",source="CME_ClearedConfirm_1_17",path="trade")
        public final ExecutionQuantity getContractualQuantity()
        Complex attribute to specify the quantity of the contractual product that the contract is written on. This temporarily makes uses of the 'ExecutionQuantity' class, until such time when the latter can be renamed as, and supersede, the existing 'ContractualQuantity' class.
      • getDocumentation

        public final Documentation getDocumentation()
        Specifies the document(s) that govern the document, either as a reference to such documents when specified as part of the CDM, or through identification of some of the key terms of those documents, such as the type of document, the document identifier, the publisher, the document vintage and the agreement date.
      • getGoverningLaw

        @RosettaSynonym(value="governingLaw",source="FpML_5_10",path="trade") @RosettaSynonym(value="governingLaw",source="DTCC_11_0",path="trade") @RosettaSynonym(value="governingLaw",source="DTCC_9_0",path="trade") @RosettaSynonym(value="governingLaw",source="CME_SubmissionIRS_1_0",path="trade") @RosettaSynonym(value="governingLaw",source="CME_ClearedConfirm_1_17",path="trade") @RosettaSynonym(value="governingLaw",source="FpML_5_10") @RosettaSynonym(value="governingLaw",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="governingLaw",source="CME_ClearedConfirm_1_17")
        public final FieldWithMetaGoverningLawEnum getGoverningLaw()
        Identification of the law governing the contract.
      • getMeta

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

        @RosettaSynonym(value="party",source="FpML_5_10") @RosettaSynonym(value="party",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="party",source="DTCC_11_0") @RosettaSynonym(value="party",source="DTCC_9_0") @RosettaSynonym(value="party",source="CME_ClearedConfirm_1_17") @RosettaSynonym(value="party",source="CME_SubmissionIRS_1_0",path="Instrmt.SecXML.FpML")
        public final java.util.List<Party> getParty()
        The parties to the contract. The cardinality is optional to address the case where the contract object is part of an event record, in which case the party is specified as part of that object. In that respect, the CDM approach is distinct from FpML, where party information is specified as part of a wrapper alongside the trade object.
      • getPartyContractInformation

        @RosettaSynonym(value="partyTradeInformation",source="FpML_5_10",path="trade.tradeHeader") @RosettaSynonym(value="partyTradeInformation",source="CME_SubmissionIRS_1_0",path="trade.tradeHeader") @RosettaSynonym(value="partyTradeInformation",source="DTCC_11_0",path="trade.tradeHeader") @RosettaSynonym(value="partyTradeInformation",source="DTCC_9_0",path="trade.tradeHeader") @RosettaSynonym(value="partyTradeInformation",source="CME_ClearedConfirm_1_17",path="trade.tradeHeader")
        public final java.util.List<PartyContractInformation> getPartyContractInformation()
        Additional contract information that may be provided by each involved party.
      • getPartyRole

        public final java.util.List<PartyRole> getPartyRole()
        The role(s) that party(ies) may have in relation to the contract, further to the principal parties (i.e payer/receive or buyer/seller) to it.
      • getTradeDate

        public final TradeDate getTradeDate()
        The date on which the contract has been executed.
      • metaData

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

        public Contract.ContractBuilder toBuilder()
        Specified by:
        toBuilder 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