001/*
002 * (C) Copyright 2012 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Thomas Roger
018 */
019
020package org.nuxeo.ecm.csv.core;
021
022import java.io.File;
023import java.util.List;
024
025import org.nuxeo.ecm.core.api.Blob;
026import org.nuxeo.ecm.core.api.CoreSession;
027import org.nuxeo.ecm.csv.core.CSVImportLog.Status;
028
029/**
030 * @author <a href="mailto:[email protected]">Thomas Roger</a>
031 * @since 5.7
032 */
033public interface CSVImporter {
034
035    /**
036     * @deprecated since 9.1 use {@link #launchImport(CoreSession, String, Blob, CSVImporterOptions)} instead.
037     */
038    @Deprecated
039    String launchImport(CoreSession session, String parentPath, File csvFile, String csvFileName,
040            CSVImporterOptions options);
041
042    /**
043     * @since 9.1
044     */
045    String launchImport(CoreSession session, String parentPath, Blob blob, CSVImporterOptions options);
046
047    CSVImportStatus getImportStatus(String id);
048
049    List<CSVImportLog> getImportLogs(String id);
050
051    List<CSVImportLog> getImportLogs(String id, Status... status);
052
053    List<CSVImportLog> getLastImportLogs(String id, int max);
054
055    default List<CSVImportLog> getLastImportLogs(String id, int max, Status... status) {
056        return null;
057    }
058
059    CSVImportResult getImportResult(String id);
060}