javastrava.service.RouteService Maven / Gradle / Ivy

Go to download
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.auth.ref.AuthorisationScope;
import javastrava.model.StravaRoute;
import retrofit.http.Path;

/**
 * 
 * Routes are manually-created paths made up of sections called legs. Currently it is only possible to create routes using the
 * Routebuilder web interface.
 * 
 *
 * @author Dan Shannon
 *
 */
public interface RouteService extends StravaService {
	/**
	 * 
	 * This request is used to retrieve details about a route. Private routes can only be accessed if owned by the authenticating
	 * user and the token has {@link AuthorisationScope#VIEW_PRIVATE view_private} permissions. For raw data associated with a route
	 * see route streams.
	 * 
	 *
	 * @param routeId
	 *            The identifier of the route to retrieve
	 * @return The route
	 */
	public StravaRoute getRoute(@Path("id") Integer routeId);

	/**
	 * 
	 * This request is used to retrieve details about a route. Private routes can only be accessed if owned by the authenticating
	 * user and the token has {@link AuthorisationScope#VIEW_PRIVATE view_private} permissions. For raw data associated with a route
	 * see route streams.
	 * 
	 *
	 * @param routeId
	 *            The identifier of the route to retrieve
	 * @return The future on which to execute get() to retrieve the route
	 */
	public CompletableFuture getRouteAsync(Integer routeId);

	/**
	 * 
	 * Lists a specific athlete’s routes. Private routes will only be included if the authenticating user is viewing their own
	 * routes and the token has {@link AuthorisationScope#VIEW_PRIVATE view_private} permissions.
	 * 
	 *
	 * @param id
	 *            The athlete id whose routes should be listed
	 * @return The route
	 */
	public List listAthleteRoutes(Integer id);

	/**
	 * 
	 * Lists a specific athlete’s routes. Private routes will only be included if the authenticating user is viewing their own
	 * routes and the token has {@link AuthorisationScope#VIEW_PRIVATE view_private} permissions.
	 * 
	 *
	 * @param id
	 *            The athlete id whose routes should be listed
	 * @return The future to execute get() on to return the routes
	 */
	public CompletableFuture> listAthleteRoutesAsync(Integer id);

}