Package tbdex.sdk.httpserver.models

Interface ExchangesApi

  • All Implemented Interfaces:
    
public interface ExchangesApi

    Interface representing an API for interacting with TBDex exchanges and related entities.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract List<Message> getExchange(String id, String requesterDid) Retrieves the exchange with the specified ID.
      abstract List<List<Message>> getExchanges(GetExchangesFilter filter) Retrieves a list of exchanges based on the provided filter.
      abstract Rfq getRfq(String exchangeId) Retrieves the Request for Quote (RFQ) for the specified exchange ID.
      abstract Quote getQuote(String exchangeId) Retrieves the Quote for the specified exchange ID.
      abstract Order getOrder(String exchangeId) Retrieves the Order for the specified exchange ID.
      abstract List<OrderStatus> getOrderStatuses(String exchangeId) Retrieves the list of Order Statuses for the specified exchange ID.
      abstract Close getClose(String exchangeId) Retrieves the Close information for the specified exchange ID.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • getExchange

         abstract List<Message> getExchange(String id, String requesterDid)

        Retrieves the exchange with the specified ID.

        Parameters:
        id - The ID of the exchange to retrieve.
        requesterDid - The DID of the requester.
        Returns:

        A list of Message representing the exchange with the specified ID.

      • getExchanges

         abstract List<List<Message>> getExchanges(GetExchangesFilter filter)

        Retrieves a list of exchanges based on the provided filter.

        Parameters:
        filter - The filter criteria for retrieving exchanges.
        Returns:

        A list of lists of Message representing exchanges based on the filter.

      • getRfq

         abstract Rfq getRfq(String exchangeId)

        Retrieves the Request for Quote (RFQ) for the specified exchange ID.

        Parameters:
        exchangeId - The ID of the exchange to retrieve the RFQ for.
        Returns:

        The Rfq object representing the RFQ for the specified exchange.

      • getQuote

         abstract Quote getQuote(String exchangeId)

        Retrieves the Quote for the specified exchange ID.

        Parameters:
        exchangeId - The ID of the exchange to retrieve the Quote for.
        Returns:

        The Quote object representing the Quote for the specified exchange.

      • getOrder

         abstract Order getOrder(String exchangeId)

        Retrieves the Order for the specified exchange ID.

        Parameters:
        exchangeId - The ID of the exchange to retrieve the Order for.
        Returns:

        The Order object representing the Order for the specified exchange.

      • getOrderStatuses

         abstract List<OrderStatus> getOrderStatuses(String exchangeId)

        Retrieves the list of Order Statuses for the specified exchange ID.

        Parameters:
        exchangeId - The ID of the exchange to retrieve Order Statuses for.
        Returns:

        A list of OrderStatus objects representing the Order Statuses for the specified exchange, or an empty list if none are found.

      • getClose

         abstract Close getClose(String exchangeId)

        Retrieves the Close information for the specified exchange ID.

        Parameters:
        exchangeId - The ID of the exchange to retrieve the Close information for.
        Returns:

        The Close object representing the Close information for the specified exchange.