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.shared.rpc;
029
030import org.opencms.gwt.shared.CmsUploadFileBean;
031import org.opencms.gwt.shared.CmsUploadProgessInfo;
032
033import java.util.List;
034
035import com.google.gwt.user.client.rpc.AsyncCallback;
036
037/**
038 * Handles all RPC services related to the upload dialog.<p>
039 *
040 * @since 8.0.0
041 *
042 * @see org.opencms.ade.upload.CmsUploadService
043 * @see org.opencms.gwt.shared.rpc.I_CmsUploadService
044 * @see org.opencms.gwt.shared.rpc.I_CmsUploadServiceAsync
045 */
046public interface I_CmsUploadServiceAsync {
047
048    /**
049     * Cancels the upload.<p>
050     *
051     * @param callback the asynchronous callback
052     */
053    void cancelUpload(AsyncCallback<Boolean> callback);
054
055    /**
056     * Checks the availability of a resource in the VFS, using the
057     * {@link org.opencms.file.CmsResourceFilter#IGNORE_EXPIRATION} filter.<p>
058     *
059     * Calculates the VFS path for each filename in the given list and checks its availability.<p>
060     *
061     * @param fileNames the filenames to check
062     * @param targetFolder the folder to check
063     * @param isRootPath <code>true</code> in case the target folder path is a root path
064     * @param callback the async callback
065     */
066    void checkUploadFiles(
067        List<String> fileNames,
068        String targetFolder,
069        boolean isRootPath,
070        AsyncCallback<CmsUploadFileBean> callback);
071
072    /**
073     * Returns the upload progress information.<p>
074     *
075     * @param callback the asynchronous callback
076     */
077    void getUploadProgressInfo(AsyncCallback<CmsUploadProgessInfo> callback);
078}