/*
* Copyright 2011 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gdg.frisbee.android.utils.base;
import android.location.Location;
import android.location.LocationListener;
/**
* Interface definition for a Last Location Finder.
*
* Classes that implement this interface must provide methods to
* find the "best" (most accurate and timely) previously detected
* location using whatever providers are available.
*
* Where a timely / accurate previous location is not detected, classes
* should return the last location and create a one-shot update to find
* the current location. The one-shot update should be returned via the
* Location Listener passed in through setChangedLocationListener.
*/
public interface ILastLocationFinder {
/**
* Find the most accurate and timely previously detected location
* using all the location providers. Where the last result is beyond
* the acceptable maximum distance or latency create a one-shot update
* of the current location to be returned using the {@link LocationListener}
* passed in through {@link setChangedLocationListener}
* @param minDistance Minimum distance before we require a location update.
* @param minTime Minimum time required between location updates.
* @return The most accurate and / or timely previously detected location.
*/
Location getLastBestLocation(int minDistance, long minTime);
/**
* Set the {@link LocationListener} that may receive a one-shot current location update.
* @param l LocationListener
*/
void setChangedLocationListener(LocationListener l);
/**
* Cancel the one-shot current location update.
*/
void cancel();
}