com.chutneytesting.design.domain.dataset.DataSetHistoryRepository Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of server Show documentation

There is a newer version: 3.0.0

package com.chutneytesting.design.domain.dataset;

import java.util.Map;
import java.util.Optional;
import org.apache.commons.lang3.tuple.Pair;

/**
 * Repository interface for dataset's history management
 */
public interface DataSetHistoryRepository {

    /**
     * Retrieve last version of dataset with given id
     *
     * @param dataSetId The dataset id
     * @return The last version number
     * @throws DataSetNotFoundException
     */
    Integer lastVersion(String dataSetId);

    /**
     * Add a given dataset version
     *
     * @param newDataSet The dataset version to add
     * @return The Pair id / version of created version or empty if no differences were found to save
     * @throws DataSetNotFoundException
     */
    Optional> addVersion(DataSet newDataSet);

    /**
     * Retrieve all versions of a dataset with given id
     *
     * @param dataSetId The dataset id
     * @return The map of existing datasets with versions keys
     */
    Map allVersions(String dataSetId);

    /**
     * Retrieve a specific dataset version
     *
     * @param dataSetId The dataset id
     * @param version   The version number
     * @return The dataset version
     * @throws DataSetNotFoundException
     */
    DataSet version(String dataSetId, Integer version);

    /**
     * Delete the version history of dataset with given id
     *
     * @param dataSetId Teh dataset id
     */
    void removeHistory(String dataSetId);
}