javastrava.service.RunningRaceService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of javastrava-api Show documentation

Java implementation of the Strava API

The newest version!

/**
 *
 */
package javastrava.service;

import java.util.List;
import java.util.concurrent.CompletableFuture;

import javastrava.model.StravaRunningRace;

/**
 * 
 * Service specs for running race endpoint
 * 
 *
 * @author Dan Shannon
 *
 */
public interface RunningRaceService extends StravaService {
	/**
	 * 
	 * Get details of a specific running race
	 * 
	 *
	 * @param id
	 *            The id of the race to be retrieved
	 * @return A detailed representation of the running race
	 */
	public StravaRunningRace getRace(final Integer id);

	/**
	 * 
	 * Get details of a specific running race
	 * 
	 *
	 * @param id
	 *            The id of the race to be retrieved
	 * @return A future which will return a detailed representation of the running race
	 */
	public CompletableFuture getRaceAsync(final Integer id);

	/**
	 * 
	 * List Strava's featured running races
	 * 
	 *
	 * @param year
	 *            (Optional) restrict results to the given year
	 * @return List of running races as summary representations
	 */
	public List listRaces(final Integer year);

	/**
	 * 
	 * List Strava's featured running races
	 * 
	 *
	 * @param year
	 *            (Optional) restrict results to the given year
	 * @return Future containing list of running races as summary representations
	 */
	public CompletableFuture> listRacesAsync(final Integer year);

}