com.sportradar.unifiedodds.sdk.entities.Competitor Maven / Gradle / Ivy

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

package com.sportradar.unifiedodds.sdk.entities;

import java.util.List;
import java.util.Locale;
import java.util.Map;

/**
 * An interface providing methods to access competitor data
 */
public interface Competitor extends Player {
    /**
     * Returns an unmodifiable map of available translated competitor country names
     *
     * @return an unmodifiable map of available translated competitor country names
     */
    Map getCountries();

    /**
     * Returns an unmodifiable map of available translated competitor abbreviations
     *
     * @return an unmodifiable map of available translated competitor abbreviations
     */
    Map getAbbreviations();

    /**
     * Returns a value indicating whether the current instance represents a virtual {@link Competitor}
     * i.e. competes in a virtual sports
     *
     * @return - a value indicating whether the current instance represents a virtual {@link Competitor}
     */
    boolean isVirtual();

    /**
     * Returns the reference ids
     *
     * @return - the reference ids
     */
    Reference getReferences();

    /**
     * Returns a {@link String} representation of a country code
     *
     * @return - a {@link String} representation of a country code
     */
    String getCountryCode();

    /**
     * Returns the translated competitor country name
     *
     * @param locale - a {@link Locale} specifying the language in which to get the country name
     * @return - the translated competitor country name
     */
    String getCountry(Locale locale);

    /**
     * Returns the translated competitor abbreviation
     *
     * @param locale - a {@link Locale} specifying the language in which to get the abbreviation
     * @return - the translated competitor abbreviation
     */
    String getAbbreviation(Locale locale);

    /**
     * Returns a {@link List} of associated players
     *
     * @return {@link List} of associated players
     */
    List getPlayers();

    /**
     * Returns a {@link List} of known competitor jerseys
     *
     * @return {@link List} of known competitor jerseys
     */
    List getJerseys();

    /**
     * Returns the associated competitor manager
     *
     * @return the associated competitor manager
     */
    Manager getManager();

    /**
     * Return the associated competitor home venue
     *
     * @return the associated competitor home venue
     */
    Venue getVenue();
}