FormRepository.java

package com.ushahidi.platform.mobile.app.domain.repository;

import com.ushahidi.platform.mobile.app.domain.entity.Form;
import com.ushahidi.platform.mobile.app.domain.entity.From;

import java.util.List;

import rx.Observable;

/**
 * Repository for manipulating {@link Form} data
 *
 * @author Ushahidi Team <team@ushahidi.com>
 */
public interface FormRepository {

    /**
     * Get a list of {@link Form} from either the database or online.
     *
     * @param deploymentId An ID of {@link com.ushahidi.platform.mobile.app.domain.entity.Deployment}
     * @param from         Where to get the form from. Either from local storage or online
     * @return The form details
     */
    Observable<List<Form>> getForms(Long deploymentId, From from);

    /**
     * Get a list of {@link Form} from either the database or online.
     *
     * @param deploymentId An ID of {@link com.ushahidi.platform.mobile.app.domain.entity.Deployment}
     * @param formId       The id of the form to be fetched
     * @return The form details
     */
    Observable<Form> getForm(Long deploymentId, Long formId);

    /**
     * Add/Update a {@link Form}.
     *
     * @param form The Form to be saved.
     * @return The row affected
     */
    Observable<Long> putForm(Form form);

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

}