Interface MarketDefinition


public interface MarketDefinition
Represents a market definition which is related to an event message
  • Method Details

    • getOutcomeType

      String getOutcomeType()
      Returns the market attribute "outcome_type"
      Returns:
      the market attribute "outcome_type"
    • getNameTemplate

      String getNameTemplate()
      Returns the market name template translated in the default locale. Market name templates are obtained with MarketDescription.getName(Locale)
      Returns:
      the market name template translated in the default locale.
    • getNameTemplate

      String getNameTemplate(Locale locale)
      Returns the market name template translated in the provided locale. Market name templates are obtained with MarketDescription.getName(Locale)
      Parameters:
      locale - the locale in which the name should be returned
      Returns:
      the market name template translated in the provided locale.
    • getGroups

      List<String> getGroups()
      Returns a List of groups to which the market belongs to. Market groups are used to perform batch market operations, ex. betstop messages may have an indication for which group of markets the betstop message is valid
      Returns:
      a List of groups to which the market belongs to
    • getAttributes

      Map<String,String> getAttributes()
      Returns a List of additional market attributes. Market attributes are used to identify special markets, ex. flex market
      Returns:
      a List of additional market attributes
    • getValidMappings

      List<MarketMappingData> getValidMappings(Locale locale)
      Returns a List of valid market mappings that are valid for the associated event message, the mappings are returned in the raw format provided by the API
      Parameters:
      locale - a Locale for which the mappings should be provided
      Returns:
      a List of valid market mappings
    • getValidMappings

      List<MarketMappingData> getValidMappings(Locale locale, boolean adjustMappingsWithMessageData)
      Returns a List of valid market mappings that are valid for the associated event message, based on the input parameters the mappings can be adjusted with the content of the associated markets.

      As an example, flex score markets mappings will have outcome score names adjusted with the specifier values that are a part of the associated message.
      Raw outcome name: 1:0
      Score specifier value: 1:1
      Adjusted outcome name: 2:1

      Parameters:
      locale - a Locale for which the mappings should be provided
      adjustMappingsWithMessageData - true if you want to get adjusted mapping data based on the associated market specifiers, otherwise false
      Returns:
      a List of valid market mappings