Class CollateralReport


  • public class CollateralReport
    extends Object
    Collateral Report Message.
    • Method Detail

      • getSenderCompID

        public final String getSenderCompID()
        Gets value used to identify customer firm sending message.
        Returns:
        value used to identify customer firm sending message
      • setSenderCompID

        public final void setSenderCompID​(String value)
        Sets value used to identify customer firm sending message.
        Parameters:
        value - value used to identify customer firm sending message
      • getTargetSubID

        public final String getTargetSubID()
        Value used to identify specific message recipient (user, etc.) This echoes the SenderSubID sent on the request.
        Returns:
        value used to identify specific message recipient (user, etc.)
      • setTargetSubID

        public final void setTargetSubID​(String value)
        Value used to identify specific message recipient (user, etc.) This echoes the SenderSubID sent on the request.
        Parameters:
        value - value used to identify specific message recipient (user, etc.)
      • getSenderSubID

        public final String getSenderSubID()
        CME assigned user role used to identify specific role (traderadmin or clearingadmin). If not specified will default to highest assigned role.
        Returns:
        CME assigned user role used to identify specific role (traderadmin or clearingadmin)
      • setSenderSubID

        public final void setSenderSubID​(String value)
        CME assigned user role used to identify specific role (traderadmin or clearingadmin). If not specified will default to highest assigned role.
        Parameters:
        value - CME assigned user role used to identify specific role (traderadmin or clearingadmin)
      • getTargetCompID

        public final String getTargetCompID()
        Gets entity to whom the message is being sent. This echoes the SenderCompID sent on the request.
        Returns:
        entity to whom the message is being sent
      • setTargetCompID

        public final void setTargetCompID​(String value)
        Sets the entity to whom the message is being sent. This echoes the SenderCompID sent on the request.
        Parameters:
        value - the entity to whom the message is being sent
      • getCollateralReportID

        public final String getCollateralReportID()
        Gets Collateral Report Identifier.
        Returns:
        Collateral Report Identifier
      • setCollateralReportID

        public final void setCollateralReportID​(String value)
        Sets Collateral Report Identifier.
        Parameters:
        value - Collateral Report Identifier
      • getCollateralRequestID

        public final String getCollateralRequestID()
        Gets Collateral Request Identifier.
        Returns:
        Collateral Request Identifier
      • setCollateralRequestID

        public final void setCollateralRequestID​(String value)
        Sets Collateral Request Identifier.
        Parameters:
        value - Collateral Request Identifier
      • getCollateralAllocationID

        public final String getCollateralAllocationID()
        Gets globally unique identifier of the collateral allocation.
        Returns:
        globally unique identifier of the collateral allocation
      • setCollateralAllocationID

        public final void setCollateralAllocationID​(String value)
        Sets globally unique identifier of the collateral allocation.
        Parameters:
        value - globally unique identifier of the collateral allocation
      • getCollateralAllocationNumber

        public final String getCollateralAllocationNumber()
        Gets globally unique identifier of the collateral allocation.
        Returns:
        globally unique identifier of the collateral allocation
      • setCollateralAllocationNumber

        public final void setCollateralAllocationNumber​(String value)
        Sets human-readable identifier for the collateral allocation.
        Parameters:
        value - human-readable identifier for the collateral allocation
      • getOriginalCollateralAllocationID

        public final String getOriginalCollateralAllocationID()
        In a substitution, this is the CollID of the allocation that was substituted.
        Returns:
        CollID of the allocation that was substituted
      • setOriginalCollateralAllocationID

        public final void setOriginalCollateralAllocationID​(String value)
        In a substitution, this is the CollID of the allocation that was substituted.
        Parameters:
        value - CollID of the allocation that was substituted
      • getOriginalCollateralAllocationNumber

        public final String getOriginalCollateralAllocationNumber()
        In a substitution, this is the CollNo of the allocation that was substituted.
        Returns:
        CollNo of the allocation that was substituted
      • setOriginalCollateralAllocationNumber

        public final void setOriginalCollateralAllocationNumber​(String value)
        In a substitution, this is the CollNo of the allocation that was substituted.
        Parameters:
        value - CollNo of the allocation that was substituted
      • getTransactTime

        public final HighResolutionTimestamp getTransactTime()
        Gets the timestamp when the business transaction represented by the message occurred.
        Returns:
        timestamp when the business transaction represented by the message occurred
      • setTransactTime

        public final void setTransactTime​(HighResolutionTimestamp value)
        Sets the timestamp when the business transaction represented by the message occurred.
        Parameters:
        value - timestamp when the business transaction represented by the message occurred
      • getLastUpdateTime

        public final HighResolutionTimestamp getLastUpdateTime()
        Gets the timestamp of last update to data item (or creation if no updates made since creation).
        Returns:
        timestamp of last update to data item (or creation if no updates made since creation)
      • setLastUpdateTime

        public final void setLastUpdateTime​(HighResolutionTimestamp value)
        Sets the timestamp of last update to data item (or creation if no updates made since creation).
        Parameters:
        value - timestamp of last update to data item (or creation if no updates made since creation)
      • getCollateralReportTransactionType

        public final CollateralReportTransactionType getCollateralReportTransactionType()
        Gets the transaction type of the Collateral Report.
        Returns:
        transaction type of the Collateral Report
      • setCollateralReportTransactionType

        public final void setCollateralReportTransactionType​(CollateralReportTransactionType value)
        Sets the transaction type of the Collateral Report.
        Parameters:
        value - transaction type of the Collateral Report
      • getCollateralStatus

        public final CollateralStatus getCollateralStatus()
        Gets the collateral status.
        Returns:
        collateral status
      • setCollateralStatus

        public final void setCollateralStatus​(CollateralStatus value)
        Sets the collateral status.
        Parameters:
        value - collateral status
      • getTradeCollateralStatus

        public final TradeCollateralStatus getTradeCollateralStatus()
        Gets the collateral status of the trade.
        Returns:
        collateral status of the trade
      • setTradeCollateralStatus

        public final void setTradeCollateralStatus​(TradeCollateralStatus value)
        Sets the collateral status of the trade.
        Parameters:
        value - collateral status of the trade
      • getMaximumCollateralCount

        public final int getMaximumCollateralCount()
        Gets the maximum number of different securities that can be allocated to the trade.
        Returns:
        maximum number of different securities that can be allocated to the trade
      • setMaximumCollateralCount

        public final void setMaximumCollateralCount​(int value)
        Sets the maximum number of different securities that can be allocated to the trade.
        Parameters:
        value - maximum number of different securities that can be allocated to the trade
      • getSecondaryTradeID

        public final String getSecondaryTradeID()
        Used to carry an internal trade entity ID which may or may not be reported to the firm.
        Returns:
        internal trade entity ID which may or may not be reported to the firm
      • setSecondaryTradeID

        public final void setSecondaryTradeID​(String value)
        Used to carry an internal trade entity ID which may or may not be reported to the firm.
        Parameters:
        value - internal trade entity ID which may or may not be reported to the firm
      • getQuantity

        public final ScaledDecimal getQuantity()
        Gets the overall/total quantity (e.g. number of shares).
        Returns:
        overall/total quantity (e.g. number of shares)
      • setQuantity

        public final void setQuantity​(ScaledDecimal value)
        Sets the overall/total quantity (e.g. number of shares).
        Parameters:
        value - overall/total quantity (e.g. number of shares)
      • getSide

        public final Side getSide()
        Gets the side of order.
        Returns:
        side of order
      • setSide

        public final void setSide​(Side value)
        Sets the side of order.
        Parameters:
        value - side of order
      • getPrice

        public final ScaledDecimal getPrice()
        Gets the price per unit of quantity (e.g. per share).
        Returns:
        price per unit of quantity (e.g. per share)
      • setPrice

        public final void setPrice​(ScaledDecimal value)
        Sets the price per unit of quantity (e.g. per share).
        Parameters:
        value - price per unit of quantity (e.g. per share)
      • getDirtyPrice

        public final ScaledDecimal getDirtyPrice()
        Gets the dirty price.
        Returns:
        dirty price
      • setDirtyPrice

        public final void setDirtyPrice​(ScaledDecimal value)
        Sets the dirty price.
        Parameters:
        value - dirty price
      • getAccruedInterestAmount

        public final ScaledDecimal getAccruedInterestAmount()
        Gets the amount of Accrued Interest for convertible bonds and fixed income.
        Returns:
        amount of Accrued Interest for convertible bonds and fixed income
      • setAccruedInterestAmount

        public final void setAccruedInterestAmount​(ScaledDecimal value)
        Sets the amount of Accrued Interest for convertible bonds and fixed income.
        Parameters:
        value - amount of Accrued Interest for convertible bonds and fixed income
      • getStartCash

        public final ScaledDecimal getStartCash()
        Starting dirty cash consideration of a financing deal, i.e. paid to the seller on the Start Date.
        Returns:
        starting dirty cash consideration of a financing deal
      • setStartCash

        public final void setStartCash​(ScaledDecimal value)
        Starting dirty cash consideration of a financing deal, i.e. paid to the seller on the Start Date.
        Parameters:
        value - starting dirty cash consideration of a financing deal
      • getEndCash

        public final ScaledDecimal getEndCash()
        Ending dirty cash consideration of a financing deal. i.e. reimbursed to the buyer on the End Date.
        Returns:
        ending dirty cash consideration of a financing deal
      • setEndCash

        public final void setEndCash​(ScaledDecimal value)
        Ending dirty cash consideration of a financing deal. i.e. reimbursed to the buyer on the End Date.
        Parameters:
        value - ending dirty cash consideration of a financing deal
      • getTotalStartCash

        public final ScaledDecimal getTotalStartCash()
        Gets the total start cash of the trade.
        Returns:
        total start cash of the trade
      • setTotalStartCash

        public final void setTotalStartCash​(ScaledDecimal value)
        Sets the total start cash of the trade.
        Parameters:
        value - total start cash of the trade
      • getTotalEndCash

        public final ScaledDecimal getTotalEndCash()
        Gets the total end cash of the trade.
        Returns:
        total end cash of the trade
      • setTotalEndCash

        public final void setTotalEndCash​(ScaledDecimal value)
        Sets the total end cash of the trade.
        Parameters:
        value - total end cash of the trade
      • getClearingBusinessDate

        public final LocalDate getClearingBusinessDate()
        Gets the "Clearing Business Date" referred to by this maintenance request.
        Returns:
        the "Clearing Business Date" referred to by this maintenance request
      • setClearingBusinessDate

        public final void setClearingBusinessDate​(LocalDate value)
        Sets the "Clearing Business Date" referred to by this maintenance request.
        Parameters:
        value - the "Clearing Business Date" referred to by this maintenance request.
      • getTradeDate

        public final LocalDate getTradeDate()
        Indicates date of trade referenced in this message in YYYYMMDD format. Absence of this field indicates current day (expressed in local time at place of trade).
        Returns:
        date of trade referenced in this message in YYYYMMDD format
      • setTradeDate

        public final void setTradeDate​(LocalDate value)
        Indicates date of trade referenced in this message in YYYYMMDD format. Absence of this field indicates current day (expressed in local time at place of trade).
        Parameters:
        value - date of trade referenced in this message in YYYYMMDD format
      • getSubstitutionIndicator

        public final SubstitutionIndicator getSubstitutionIndicator()
        Indicates the status of the substitution.
        Returns:
        status of the substitution
      • setSubstitutionIndicator

        public final void setSubstitutionIndicator​(SubstitutionIndicator value)
        Indicates the status of the substitution.
        Parameters:
        value - status of the substitution
      • getSubstitutionsRemaining

        public final int getSubstitutionsRemaining()
        Gets the number of remaining rights of substitution.
        Returns:
        number of remaining rights of substitution
      • setSubstitutionsRemaining

        public final void setSubstitutionsRemaining​(int value)
        Sets the number of remaining rights of substitution.
        Parameters:
        value - number of remaining rights of substitution
      • getMemo

        public final String getMemo()
        Gets the free format text field.
        Returns:
        free format text field
      • setMemo

        public final void setMemo​(String value)
        Sets the free format text field.
        Parameters:
        value - free format text field
      • getSettlementTradeID

        public final String getSettlementTradeID()
        Gets the trade identifier as assigned by BrokerTec Clearing.
        Returns:
        trade identifier as assigned by BrokerTec Clearing
      • setSettlementTradeID

        public final void setSettlementTradeID​(String value)
        Sets the trade identifier as assigned by BrokerTec Clearing.
        Parameters:
        value - trade identifier as assigned by BrokerTec Clearing
      • getLastMkt

        public final String getLastMkt()
        Gets the market of execution for last fill, or an indication of the market where an order was routed.
        Returns:
        market of execution for last fill, or an indication of the market where an order was routed
      • setLastMkt

        public final void setLastMkt​(String value)
        Sets the market of execution for last fill, or an indication of the market where an order was routed.
        Parameters:
        value - market of execution for last fill, or an indication of the market where an order was routed
      • getParties

        public final ArrayList<Party> getParties()
        Gets the information about parties reported.
        Returns:
        information about parties reported
      • getInstrument

        public final CollateralInstrument getInstrument()
        Gets the information about instrument reported.
        Returns:
        information about instrument reported
      • getFinancingDetails

        public final FinancingDetails getFinancingDetails()
        Gets the information about financing details reported.
        Returns:
        information about financing details reported
      • getRegulatoryTradeIDs

        public final ArrayList<RegulatoryTradeIdentifier> getRegulatoryTradeIDs()
        Gets the information about related regulatory trade IDs.
        Returns:
        information about related regulatory trade IDs
      • getRelatedInstruments

        public final ArrayList<RelatedInstrument> getRelatedInstruments()
        Gets the information about Related Instruments reported.
        Returns:
        information about Related Instruments reported