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