javastrava.service.SegmentEffortService 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.concurrent.CompletableFuture;

import javastrava.model.StravaAthlete;
import javastrava.model.StravaSegment;
import javastrava.model.StravaSegmentEffort;

/**
 * 
 * A {@link StravaSegmentEffort segment effort} represents an {@link StravaAthlete athlete's} attempt at a {@link StravaSegment segment}.
 * 
 *
 * 
 * It can also be thought of as a portion of a ride that covers a segment.
 * 
 *
 * 
 * The object is returned in summary or detailed representations. They are currently the same.
 * 
 *
 * @author Dan Shannon
 *
 */
public interface SegmentEffortService extends StravaService {
	/**
	 * 
	 * Retrieve details about a specific segment effort. The effort must be public or it must correspond to the current athlete.
	 * 
	 *
	 * 
	 * Returns null if the segment effort does not exist or is private
	 * 
	 *
	 * 
	 * URL GET https://www.strava.com/api/v3/segment_efforts/:id
	 * 
	 *
	 * @see http://strava.github.io/api/v3/efforts/#retrieve
	 *
	 *
	 * @param segmentEffortId
	 *            The id of the segment to be retrieved
	 * @return Returns a detailed segment effort representation
	 */
	public StravaSegmentEffort getSegmentEffort(final Long segmentEffortId);

	/**
	 * 
	 * Retrieve details about a specific segment effort. The effort must be public or it must correspond to the current athlete.
	 * 
	 *
	 * 
	 * Returns null if the segment effort does not exist or is private
	 * 
	 *
	 * 
	 * URL GET https://www.strava.com/api/v3/segment_efforts/:id
	 * 
	 *
	 * @see http://strava.github.io/api/v3/efforts/#retrieve
	 *
	 *
	 * @param segmentEffortId
	 *            The id of the segment to be retrieved
	 * @return Returns a detailed segment effort representation
	 */
	public CompletableFuture getSegmentEffortAsync(final Long segmentEffortId);
}