com.radioreference.api.RadioReferenceApi Maven / Gradle / Ivy

Go to download

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

Java library to use the RadioReference.com API

The newest version!

package com.radioreference.api;

import com.radioreference.model.Country;
import com.radioreference.model.County;
import com.radioreference.model.Feed;
import com.radioreference.model.State;

import java.util.List;

public interface RadioReferenceApi {
    /**
     * @param filter used to determine what feeds should be fetched
     * @return all feeds that matches the specified filter. If filter is null, returns all feeds.
     */
    public List getFeeds(FeedsFilter filter);

    /**
     * @return all countries that have audio feeds
     */
    public List getCountries();

    /**
     * @param countryId country ID
     * @return all states in a country, specified with parameter "coid", that have
     *         audio feeds
     */
    public List getStates(long countryId);

    /**
     * @param stateId the id of the state of the counties to fetch
     * @return all counties (or equivalent entity) in a state, specified with
     *         parameter "stateId", that have audio feeds
     */
    public List getCounties(long stateId);

    /**
     * @param countyId the id of the county to fetch
     * @return all audio feeds present in a county
     */
    public County getCounty(long countyId);

    /**
     * @param feedId individual Feed ID
     * @return details on an individual feed
     */
    public Feed getFeed(long feedId);
}