com.github.useful_solutions.tosamara_sdk.classifier.ClassifierRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tosamara-sdk Show documentation
SDK for working with API of tosamara.ru on Java
There is a newer version: 1.5
package com.github.useful_solutions.tosamara_sdk.classifier;

import com.github.useful_solutions.tosamara_sdk.classifier.pojo.*;
import com.github.useful_solutions.tosamara_sdk.exception.APIResponseException;

import java.io.IOException;
import java.util.List;

/**
 * https://tosamara.ru/api
 */
public interface ClassifierRequest {

    /**
     * Метод получения списка справочников.
     *
     * @return список справочников.
     * @throws IOException          выбрасывается в случае ошибок десериализации или ошибок соединения.
     * @throws APIResponseException выбрасывается, если код ответа не равен 200.
     */
    List getClassifiers() throws APIResponseException, IOException;

    /**
     * Метод получения всех справочников.
     *
     * @return объект, содержащий все справочники.
     * @throws IOException          выбрасывается в случае ошибок десериализации или ошибок соединения.
     * @throws APIResponseException выбрасывается, если код ответа не равен 200.
     */
    AllClassifiers getAllClassifiers() throws APIResponseException, IOException;

    /**
     * Метод получения списка остановок.
     *
     * @return список остановок.
     * @throws IOException          выбрасывается в случае ошибок десериализации или ошибок соединения.
     * @throws APIResponseException выбрасывается, если код ответа не равен 200.
     */
    List getStops() throws APIResponseException, IOException;

    /**
     * Метод получения списка остановок с расширенной информацией.
     *
     * @return список остановок с расширенной информацией.
     * @throws IOException          выбрасывается в случае ошибок десериализации или ошибок соединения.
     * @throws APIResponseException выбрасывается, если код ответа не равен 200.
     */
    List getFullStops() throws APIResponseException, IOException;

    /**
     * Метод получения списка маршрутов.
     *
     * @return список маршрутов.
     * @throws IOException          выбрасывается в случае ошибок десериализации или ошибок соединения.
     * @throws APIResponseException выбрасывается, если код ответа не равен 200.
     */
    List getRoutes() throws APIResponseException, IOException;

    /**
     * Метод получения списка связей маршрутов и остановок.
     *
     * @return список связей маршрутов и остановок.
     * @throws IOException          выбрасывается в случае ошибок десериализации или ошибок соединения.
     * @throws APIResponseException выбрасывается, если код ответа не равен 200.
     */
    List getRoutesWithStops() throws APIResponseException, IOException;

    /**
     * Метод получения остановок на карте Муниципального геопортала Самары
     *
     * @return список остановок на карте геопортала.
     * @throws IOException          выбрасывается в случае ошибок десериализации или ошибок соединения.
     * @throws APIResponseException выбрасывается, если код ответа не равен 200.
     */
    StopOnMapWrapper getStopsOnMap() throws APIResponseException, IOException;

    /**
     * Метод получения маршрутов на карте Муниципального геопортала Самары
     * Связывает маршруты со слоями и объектами на карте.
     * В каждом слое обыкновенно находятся два линейных объекта - прямое и обратное направление одного маршрута, и несколько объектов транспорта, которые движутся в реальном времени.
     *
     * @return список маршрутов на карте геопортала.
     * @throws IOException          выбрасывается в случае ошибок десериализации или ошибок соединения.
     * @throws APIResponseException выбрасывается, если код ответа не равен 200.
     */
    List getRoutesOnMap() throws APIResponseException, IOException;

}