com.sportradar.unifiedodds.sdk.oddsentities.OddsChange Maven / Gradle / Ivy

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

package com.sportradar.unifiedodds.sdk.oddsentities;

import com.sportradar.unifiedodds.sdk.entities.NamedValue;
import com.sportradar.unifiedodds.sdk.entities.SportEvent;

import java.util.List;


/**
 * Describes a set of odds changes for a particular competition
 *
 */
public interface OddsChange extends MarketMessage {

    /**
     * Get the reason why the odds changed
     * 
     * @return if RiskAdjustment this means the user changed some configuration forcing an odds
     *         change, otherwise it is a normal update based on changed conditions (i.e. something
     *         happened in the game or enough time has passed)
     */
    OddsChangeReason getChangeReason();

    /**
     * Returns the betstop reason value descriptor
     *
     * @return betstop reason value descriptor
     */
    NamedValue getBetstopReasonValue();

    /**
     * Returns the reason for the most recently sent betstop if the betstop is still active
     * 
     * @return the reason for the most recently sent betstop if the betstop is still active
     *         (otherwise null)
     */
    String getBetstopReason();

    /**
     * Returns the betting status value descriptor
     *
     * @return the betting status value descriptor
     */
    NamedValue getBettingStatusValue();

    /**
     * If this field is set, it reports that a previous betstop was sent but the markets have now
     * been reopened. A conservative bookmaker could keep the markets suspended. Previously, we call
     * it that the markets are current in early betstart.
     * 
     * @return the betting status - if set the affected markets are in early betstart otherwise
     *         null.
     */
    String getBettingStatus();

    /**
     * Returns a list of {@link MarketWithOdds} associated with the message
     * @return a list of {@link MarketWithOdds} associated with the message
     */
    List getMarkets();

    /**
     * Gets the odds generation properties (contains a few key-parameters that can be used in a client’s own special odds model, or even offer spread betting bets based on it)
     * @return the odds generation properties
     */
    default OddsGeneration getOddsGenerationProperties(){
        throw new UnsupportedOperationException("Method not implemented. Use derived type.");
    }
}