DatasetOperations.java

/*
 * 
 */
package com.researchspace.dataverse.api.v1;

import java.io.File;
import java.io.InputStream;
import java.util.List;

import com.researchspace.dataverse.entities.DataSetMetadataBlock;
import com.researchspace.dataverse.entities.Dataset;
import com.researchspace.dataverse.entities.DatasetVersion;
import com.researchspace.dataverse.entities.DataverseResponse;
import com.researchspace.dataverse.entities.DvMessage;
import com.researchspace.dataverse.entities.Identifier;
import com.researchspace.dataverse.entities.PublishedDataset;
import com.researchspace.dataverse.entities.Version;
import com.researchspace.dataverse.entities.facade.DatasetFacade;
/**
<pre>
  Copyright 2016 ResearchSpace

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   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.
 </pre>
   
 * @author richard
 *
 * Operations on Datasets
 *
 *
 */
public interface DatasetOperations {

	/**
	 * @param facade The {@link DatasetFacade} containing the updated DataSet data.
	 * @param id The {@link DataSetMetadataBlock} identifier
	 * @return A {@link DatasetVersion}
	 */
	DatasetVersion updateDataset(DatasetFacade facade, Identifier id);

    
	/**
	 * Retrieves a {@link Dataset} based on its Id.
	 * @param dsIdentifier
	 * @return
	 */
	Dataset getDataset(Identifier dsIdentifier);

	/**
	 * Gets list of metadata about different Dataset versions.
	 * @param dsIdentifier
	 * @return
	 */
	List<DatasetVersion> getDatasetVersions(Identifier dsIdentifier);

	/**
	 * Uploads a file to a dataset
	 * @param doi The DOI of the  Dataset
	 * @param file The file to add to the DataSet
	 */
	void uploadFile(String doi, File file);

	/**
	 * Uploads a file using a data stream.
	 *
	 * @param doi Identifier of the dataset that we are sending the data to.
	 * @param file Stream of data to the contents of the file to upload.
	 * @param filename Name of the file.
	 */
	void uploadFile(String doi, InputStream file, String filename);

	/**
	 * Deletes a {@link Dataset}  
	 * @param dsIdentifier
	 * @return
	 */
	DvMessage deleteDataset(Identifier dsIdentifier);
	
	/**
	 * Publishes a DataSet, if the parent dataverse is published.
	 * @param dsIdentifier
	 * @param version Major/Minor
	 * @return A {@link DataverseResponse} with  an error message if Dataset could not be published.
	 */
	DataverseResponse<PublishedDataset> publishDataset(Identifier dsIdentifier, Version version);
}