Interface OrderSummaryService


  • public interface OrderSummaryService
    Provides order summary services.
    Since:
    $Release$
    Version:
    $Id$
    Author:
    Colin DuPlantis
    • Method Detail

      • findByReportId

        OrderSummary findByReportId​(long inReportId)
        Find the order summary with the given report id.
        Parameters:
        inReportId - a long value
        Returns:
        an OrderStatus value or null
      • findByOrderId

        Optional<? extends OrderSummary> findByOrderId​(OrderID inOrderId)
        Find the order summaries with the given order id.

        Be aware that there is no FIX-requirement that the order ID be unique between venues or days. Therefore, this method might not retrieve unique results.

        Parameters:
        inOrderId - an OrderID value
        Returns:
        an Optional<OrderStatus> value
      • findMostRecentByRootOrderId

        OrderSummary findMostRecentByRootOrderId​(OrderID inRootOrderId)
        Find the order status of the most recent order in the given order chain.
        Parameters:
        inRootOrderId - an OrderID value
        Returns:
        an OrderStatusvalue or null
      • findMostRecentExecutionByRootOrderId

        OrderSummary findMostRecentExecutionByRootOrderId​(OrderID inRootOrderId)
        Find the most recent execution by the given root order id.
        Parameters:
        inRootOrderId - an OrderID value
        Returns:
        an OrderStatus value
      • save

        OrderSummary save​(OrderSummary inOrderStatus)
        Save the order status value.
        Parameters:
        inOrderStatus - an OrderStatus value
        Returns:
        an OrderStatus value
      • delete

        void delete​(OrderSummary inOrderStatus)
        Delete the given order status value.
        Parameters:
        inOrderStatus - an OrderStatus value
      • findFirstByRootOrderId

        OrderSummary findFirstByRootOrderId​(OrderID inRootOrderId)
        Find the order status of the first order in the given order chain.
        Parameters:
        inRootOrderId - an OrderID value
        Returns:
        an OrderStatusvalue or null
      • findReportByOrderStatusIn

        List<Report> findReportByOrderStatusIn​(User inViewer,
                                               Set<OrderStatus> inOrderStatusValues)
        Find the reports that have an open order status.
        Parameters:
        inViewer - a SimpleUser value
        inOrderStatusValues - a Set<OrderStatus> value
        Returns:
        a List<Report> value
      • findByRootOrderIdAndOrderId

        OrderSummary findByRootOrderIdAndOrderId​(OrderID inRootID,
                                                 OrderID inOrderID)
        Find the order summary with the given root order id and individual order id.
        Parameters:
        inRootID - an OrderID value
        inOrderID - an OrderID value
        Returns:
        an OrderStatusvalue or null
      • findOpenOrders

        CollectionPageResponse<OrderSummary> findOpenOrders​(PageRequest inPageRequest)
        Find the open orders using the given page attributes.
        Parameters:
        inPageRequest - a PageRequest value
        Returns:
        a CollectionPageResponse<OrderSummary> value
      • update

        OrderSummary update​(OrderSummary inOrderStatus,
                            Report inReport,
                            ReportBase inReportBase)
        Update the order status value with the given reports.
        Parameters:
        inOrderStatus - an OrderStatus value
        inReport - a Report value
        inReportBase - a ReportBase value
        Returns:
        an OrderStatus value
      • findByRootOrderId

        List<OrderSummary> findByRootOrderId​(OrderID inOrderId)
        Find the order summary values with the given root order id.
        Parameters:
        inOrderId - an OrderID value
        Returns:
        a List<OrderSummary value