com.sportradar.unifiedodds.sdk.entities.markets.MarketMappingData Maven / Gradle / Ivy

/*
 * Copyright (C) Sportradar AG. See LICENSE for full license governing this code
 */

package com.sportradar.unifiedodds.sdk.entities.markets;

import com.sportradar.utils.URN;

import java.util.Map;
import java.util.Set;

/**
 * Defines methods used to access market mapping data provided by the API
 */
public interface MarketMappingData {
    /**
     * The producer id for which the mapping data is valid
     *
     * @deprecated since 2.0.1, user {@link #getProducerIds()}
     * @return the producer id for which the mapping data is valid
     */
    @Deprecated
    int getProducerId();

    /**
     * The associated producer ids
     *
     * @return the producer ids for which the mappings are valid
     */
    Set getProducerIds();

    /**
     * The sport id for which the mapping data is valid
     *
     * @return the sport id for which the mapping data is valid
     */
    URN getSportId();

    /**
     * Returns the market id
     *
     * @return the market id
     */
    String getMarketId();

    /**
     * Returns the market type id
     *
     * @return the market type id
     */
    int getMarketTypeId();

    /**
     * Returns the market sub type id
     *
     * @return the market sub type id
     */
    Integer getMarketSubTypeId();

    /**
     * Returns the "special odds value"
     *
     * @return the "special odds value"
     */
    String getSovTemplate();

    /**
     * Returns a {@link Map} of valid outcome mappings for this {@link MarketMappingData}
     *
     * @return a {@link Map} of valid outcome mappings
     */
    Map getOutcomeMappings();

    /**
     * Returns a {@link String} describing for which specifier values the mapping is valid
     *
     * @return a {@link String} describing for which specifier values the mapping is valid
     */
    String getValidFor();

    /**
     * Indicates if the mapping data is usable with the provided values
     *
     * @param producerId a valid producerId
     * @param sportId a valid {@link URN} sport identifier
     * @param specifiers a {@link Map} of feed message specifiers
     * @return true if the mapping data is valid for the provided values; otherwise false
     */
    boolean canMap(int producerId, URN sportId, Map specifiers);
}