Class InstrumentStream


  • public class InstrumentStream
    extends Object
    Information about reported stream.
    • Constructor Detail

      • InstrumentStream

        public InstrumentStream()
        Default constructor.
    • Method Detail

      • getStreamType

        public StreamType getStreamType()
        Returns:
        the type of swap stream.
      • setStreamType

        public void setStreamType​(StreamType value)
        Parameters:
        value - the type of swap stream.
      • getStreamPaySide

        public Side getStreamPaySide()
        Returns:
        the side of the party paying the stream.
      • setStreamPaySide

        public void setStreamPaySide​(Side value)
        Parameters:
        value - the side of the party paying the stream.
      • getStreamReceiveSide

        public Side getStreamReceiveSide()
        Returns:
        the side of the party selling the stream.
      • setStreamReceiveSide

        public void setStreamReceiveSide​(Side value)
        Parameters:
        value - the side of the party selling the stream.
      • getStreamNotional

        public ScaledDecimal getStreamNotional()
        Returns:
        Notional, or initial notional value for the payment stream. Use the PaymentScheduleGrp component to specify the rate steps.
      • setStreamNotional

        public void setStreamNotional​(ScaledDecimal value)
        Parameters:
        value - notional, or initial notional value for the payment stream. Use the PaymentScheduleGrp component to specify the rate steps.
      • getStreamNotionalFrequencyPeriod

        public int getStreamNotionalFrequencyPeriod()
        Returns:
        time unit multiplier for the swap stream's notional frequency.
      • setStreamNotionalFrequencyPeriod

        public void setStreamNotionalFrequencyPeriod​(int value)
        Parameters:
        value - time unit multiplier for the swap stream's notional frequency.
      • getStreamNotionalFrequencyUnit

        public OriginalTimeUnit getStreamNotionalFrequencyUnit()
        Returns:
        time unit associated with the swap stream's notional frequency.
      • setStreamNotionalFrequencyUnit

        public void setStreamNotionalFrequencyUnit​(OriginalTimeUnit value)
        Parameters:
        value - time unit associated with the swap stream's notional frequency.
      • getStreamNotionalUnitOfMeasure

        public UnitOfMeasure getStreamNotionalUnitOfMeasure()
        Returns:
        the delivery stream quantity unit of measure (UOM).
      • setStreamNotionalUnitOfMeasure

        public void setStreamNotionalUnitOfMeasure​(UnitOfMeasure value)
        Parameters:
        value - the delivery stream quantity unit of measure (UOM).
      • getCommodity

        public Commodity getCommodity()
        Returns:
        information about Commodity reported.
      • getStreamEffectiveDateAdjusted

        public Date getStreamEffectiveDateAdjusted()
        Returns:
        adjusted Effective Date.
      • getStreamTerminationDateAdjusted

        public Date getStreamTerminationDateAdjusted()
        Returns:
        adjusted Termination Date.
      • getPaymentStream

        public PaymentStream getPaymentStream()
        Returns:
        a subcomponent of the Stream; details the attributes of a payment stream in a swap.
      • getDeliveryStream

        public DeliveryStream getDeliveryStream()
        Returns:
        Delivery Stream.
      • getStreamTotalNotional

        public ScaledDecimal getStreamTotalNotional()
        Returns:
        total notional or delivery quantity over the term of the contract.
      • setStreamTotalNotional

        public void setStreamTotalNotional​(ScaledDecimal value)
        Parameters:
        value - total notional or delivery quantity over the term of the contract.
      • getStreamTotalNotionalUnitOfMeasure

        public UnitOfMeasure getStreamTotalNotionalUnitOfMeasure()
        Returns:
        the unit of measure (UOM) for the total notional or delivery quantity over the term of the contract.
      • setStreamTotalNotionalUnitOfMeasure

        public void setStreamTotalNotionalUnitOfMeasure​(UnitOfMeasure value)
        Parameters:
        value - the unit of measure (UOM) for the total notional or delivery quantity over the term of the contract.