Package com.caplin.motif.fx.trading.orders.details

Interface OrderDetailsInfo

All Superinterfaces:
SubjectInfo
All Known Implementing Classes:
OrderDetailsInfoImpl
@Deprecated public interface OrderDetailsInfo extends SubjectInfo
Deprecated.

A domain object representing a request for details of a previously submitted order strategy.

You do not need to construct instances of this class yourself. They are generated from incoming requests by the FX Integration API and passed to your implementation of StrategyDetailsRequestListener.onStrategyDetailsRequest(OrderDetailsInfo, StrategyDetailsCallback).

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getOrderID()
    Deprecated.
    Gets the ID of the order the user is requesting details of.
    String
    getSubject()
    Deprecated.
    Returns the original subject that was parsed to create this SubjectInfo
    String
    getSuffix()
    Deprecated.
    Gets any optional suffix that was appended to the request by the client.
    String
    getUsername()
    Deprecated.
    Gets the username of the user who requested the details of the order strategy.
    boolean
    isSales()
    Deprecated.
     

  • Method Details

    • getUsername

      String getUsername()
      Deprecated.

      Gets the username of the user who requested the details of the order strategy.

      You are responsible for verifying that the user is permitted to view the order strategy. If he is not, you can send an error response to the client by calling StrategyDetailsCallback.onError(String).

      Returns:
      The username of the user who requested the details of the order strategy.

    • getOrderID

      String getOrderID()
      Deprecated.

      Gets the ID of the order the user is requesting details of.

      Note that this will be the ID of one of the child orders in the strategy, but you must return the details of the whole strategy the order is part of. You are responsible for retrieving the details of the requested order and determining if it is part of a multi-order strategy. If so, you will need to retrieve the other orders as well.

      This is because strategy detail requests are generally sent by clicking on an order in a blotter, but blotters usually show a single row per order rather than an order per strategy. So the row in the blotter will contain an ID for a single order only.

      Returns:
      The order ID.

    • getSuffix

      String getSuffix()
      Deprecated.
      Gets any optional suffix that was appended to the request by the client.
      Returns:
      The suffix, or an empty string if no suffix was sent on the request.

    • isSales

      boolean isSales()
      Deprecated.

    • getSubject

      String getSubject()
      Deprecated.
      Returns the original subject that was parsed to create this SubjectInfo
      Specified by:
      getSubject in interface SubjectInfo
      Returns:
      The original subject.