javastrava.api.GearAPI 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.api;

import javastrava.api.async.StravaAPICallback;
import javastrava.model.StravaGear;
import javastrava.service.exception.NotFoundException;
import retrofit.client.Response;
import retrofit.http.GET;
import retrofit.http.Path;

/**
 * 
 * API definitions for the gear services endpoints
 * 
 *
 * @author Dan Shannon
 *
 */
public interface GearAPI {
	/**
	 * @see javastrava.service.GearService#getGear(java.lang.String)
	 *
	 * @param gearId
	 *            Gear identifier
	 * @return Details of the identified gear
	 * @throws NotFoundException
	 *             If the gear with the given id doesn't exist
	 */
	@GET("/gear/{id}")
	public StravaGear getGear(@Path("id") final String gearId) throws NotFoundException;

	/**
	 * @see javastrava.service.GearService#getGear(java.lang.String)
	 *
	 * @param gearId
	 *            Gear identifier
	 * @param callback
	 *            The callback to execute on completion
	 * @throws NotFoundException
	 *             If the gear with the given id doesn't exist
	 */
	@GET("/gear/{id}")
	public void getGear(@Path("id") final String gearId, StravaAPICallback callback) throws NotFoundException;

	/**
	 * @see javastrava.service.GearService#getGear(java.lang.String)
	 *
	 * @param gearId
	 *            Gear identifier
	 * @return Details of the identified gear
	 * @throws NotFoundException
	 *             If the gear with the given id doesn't exist
	 */
	@GET("/gear/{id}")
	public Response getGearRaw(@Path("id") final String gearId) throws NotFoundException;

}