org.opennms.features.geolocation.api.GeolocationService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.opennms.features.geolocation.api Show documentation

Geolocation Services

There is a newer version: 33.1.2

Show newest version

/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2017-2017 The OpenNMS Group, Inc.
 * OpenNMS(R) is Copyright (C) 1999-2017 The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OpenNMS(R) is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with OpenNMS(R).  If not, see:
 *      http://www.gnu.org/licenses/
 *
 * For more information contact:
 *     OpenNMS(R) Licensing 
 *     http://www.opennms.org/
 *     http://www.opennms.com/
 *******************************************************************************/

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);

}