GeoJsonDataSource.java

/*
 * Copyright (c) 2015 Ushahidi Inc
 *
 * This program 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.
 *
 *  This program 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 this program in the file LICENSE-AGPL. If not, see
 *  https://www.gnu.org/licenses/agpl-3.0.html
 */

package com.ushahidi.platform.mobile.app.data.repository.datasource.geojson;

import com.ushahidi.platform.mobile.app.data.entity.GeoJsonEntity;

import rx.Observable;

/**
 * All the different source providers must implement this interface to provide geojson data
 *
 * @author Ushahidi Team <team@ushahidi.com>
 */
public interface GeoJsonDataSource {

    /**
     * Get a list of {@link GeoJsonEntity}.
     *
     * @param deploymentId The deployment ID to use to fetch the GeoJson entity.
     * @return The GeoJson entity.
     */
    Observable<GeoJsonEntity> getGeoJsonList(Long deploymentId);

    /**
     * Add/Update a {@link GeoJsonEntity}.
     *
     * @param geoJson The GeoJson to be saved.
     * @return The GeoJson entity.
     */
    Observable<Long> putGeoJson(GeoJsonEntity geoJson);

    /**
     * Delete all GeoJson with the supplied deployment id.
     *
     * @param deploymentId The deployment ID.
     * @return True upon successful deletion, otherwise false.
     */
    Observable<Boolean> deleteGeoJsonList(Long deploymentId);

}