org.opennms.features.geolocation.api.GeolocationService Maven / Gradle / Ivy
/*
* Licensed to The OpenNMS Group, Inc (TOG) under one or more
* contributor license agreements. See the LICENSE.md file
* distributed with this work for additional information
* regarding copyright ownership.
*
* TOG licenses this file to You under the GNU Affero General
* Public License Version 3 (the "License") or (at your option)
* any later version. You may not use this file except in
* compliance with the License. You may obtain a copy of the
* License at:
*
* https://www.gnu.org/licenses/agpl-3.0.txt
*
* 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.opennms.features.geolocation.api;
import java.util.List;
/**
* Service interface to allow queriing nodes which have coordiantes (or an address, which may need to be resolved).
*
* @author mvrueden
*/
public interface GeolocationService {
/**
* Returns a list of {@link GeolocationInfo} based on the {@link GeolocationQuery}.
*
* @param query the query to perform
* @return All nodes which have coordinates (may be resolved) with a status and additional information.
*/
List getLocations(GeolocationQuery query);
}