001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.gwt.client.ui.input.upload;
029
030import java.util.List;
031
032/**
033 * File uploader. Generates an asynchronous request to upload files and calls the dialog instance when done.<p>
034 */
035public interface I_CmsUploader {
036
037    /**
038     * Uploads the given files to the given URI.<p>
039     *
040     * @param uploadUri the upload URI
041     * @param targetFolder the target folder
042     * @param isRootPath true if the target folder is given as a root path
043     * @param postCreateHandler the post-create handler class, with parameters
044     * @param filesToUpload the files to upload
045     * @param filesToUnzip the files to unzip
046     * @param keepFileNames don't perform filename translation on the server if this is true
047     * @param dialog the dialog instance
048     */
049    void uploadFiles(
050        String uploadUri,
051        String targetFolder,
052        boolean isRootPath,
053        String postCreateHandler,
054        List<CmsFileInfo> filesToUpload,
055        List<String> filesToUnzip,
056        boolean keepFileNames,
057        I_CmsUploadDialog dialog);
058
059}