package cgeo.geocaching.connector;

import cgeo.geocaching.cgBase;
import cgeo.geocaching.cgCache;
import cgeo.geocaching.cgSearch;
import cgeo.geocaching.cgeoapplication;

import java.util.UUID;

public interface IConnector {
    /**
     * get name for display (currently only used in links)
     * 
     * @return
     */
    public String getName();

    /**
     * return true, if this connector is responsible for the given cache
     * 
     * @param geocode
     * @return
     */
    public boolean canHandle(final String geocode);

    public boolean supportsRefreshCache(final cgCache cache);

    /**
     * get browser URL for the given cache
     * 
     * @param cache
     * @return
     */
    public String getCacheUrl(final cgCache cache);

    /**
     * enable/disable watchlist controls in cache details
     * 
     * @return
     */
    public boolean supportsWatchList();

    /**
     * enable/disable logging controls in cache details
     * 
     * @return
     */
    public boolean supportsLogging();

    /**
     * get host name of the connector server for dynamic loading of data
     * 
     * @return
     */
    public String getHost();

    /**
     * get cache data license text
     * 
     * @param cache
     * @return
     */
    public String getLicenseText(final cgCache cache);

    /**
     * enable/disable user actions in cache details
     * 
     * @return
     */
    public boolean supportsUserActions();

    /**
     * enable/disable "caches around" action in cache details
     * 
     * @return
     */
    public boolean supportsCachesAround();

    public UUID searchByGeocode(final cgBase base, final String geocode, final String guid, final cgeoapplication app, final cgSearch search, final int reason);
}