/*
 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Nuxeo - initial API and implementation
 *
 * $Id: IODocumentManager.java 30413 2008-02-21 18:38:54Z sfermigier $
 */

package org.eclipse.ecr.core.io;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Serializable;
import java.util.Collection;

import org.eclipse.ecr.core.api.ClientException;
import org.eclipse.ecr.core.api.DocumentRef;
import org.eclipse.ecr.core.io.exceptions.ExportDocumentException;
import org.eclipse.ecr.core.io.exceptions.ImportDocumentException;

/**
 * Defines functional interface that deals directly with documents import using
 * provided DocumentReader or InputStream as a source and DocumentWriter that
 * knows how the documents will be saved into the repository.
 *
 * @author <a href="mailto:dm@nuxeo.com">Dragos Mihalache</a>
 */
public interface IODocumentManager extends Serializable {

    DocumentTranslationMap importDocuments(InputStream in, String repo,
            DocumentRef root) throws ImportDocumentException, ClientException,
            IOException;

    DocumentTranslationMap importDocuments(InputStream in,
            DocumentWriter customDocWriter) throws ImportDocumentException;

    /**
     * @param customDocReader reader from the input stream
     * @param customDocWriter
     */
    DocumentTranslationMap importDocuments(DocumentReader customDocReader,
            DocumentWriter customDocWriter) throws ImportDocumentException;

    DocumentTranslationMap exportDocuments(OutputStream out, String repo,
            Collection<DocumentRef> sources, boolean recurse, String format)
            throws ExportDocumentException, ClientException;

    /**
     * Used in pair with importDocuments(... customDocWriter)
     */
    DocumentTranslationMap exportDocuments(OutputStream out,
            DocumentReader customDocReader, String format)
            throws ExportDocumentException;
}