I_CmsPublishService.java

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.ade.publish.shared.rpc;

import org.opencms.ade.publish.shared.CmsProjectBean;
import org.opencms.ade.publish.shared.CmsPublishData;
import org.opencms.ade.publish.shared.CmsPublishGroup;
import org.opencms.ade.publish.shared.CmsPublishOptions;
import org.opencms.ade.publish.shared.CmsPublishResource;
import org.opencms.gwt.CmsRpcException;
import org.opencms.util.CmsUUID;

import java.util.List;

import com.google.gwt.user.client.rpc.RemoteService;

/**
 * The synchronous publish list interface.<p>
 * 
 * @since 8.0.0
 */
public interface I_CmsPublishService extends RemoteService {

    /**
     * Returns the initial publish data.<p>
     * 
     * @return the initial publish data
     *  
     * @throws CmsRpcException if something goes wrong
     */
    CmsPublishData getInitData() throws CmsRpcException;

    /**
     * Gets a list of projects from the server.<p>
     * 
     * @return a list of projects 
     * 
     * @throws CmsRpcException if something goes wrong 
     */
    List<CmsProjectBean> getProjects() throws CmsRpcException;

    /**
     * Retrieves the publish list, subdivided into groups based on the time of their last change.<p>
     * 
     * @param options the publish options for which the publish list should be fetched
     * 
     * @return the publish list groups 
     *  
     * @throws CmsRpcException if something goes wrong
     */
    List<CmsPublishGroup> getPublishGroups(CmsPublishOptions options) throws CmsRpcException;

    /**
     * Retrieves the publish options.<p>
     * 
     * @return the publish options last used
     * 
     * @throws CmsRpcException if something goes wrong
     */
    CmsPublishOptions getPublishOptions() throws CmsRpcException;

    /**
     * Tries to publish a list of resources.<p>
     * 
     * @param toPublish list of IDs of resources to publish
     * @param toRemove list of IDs of resources to remove from the publish list
     * @param force if <code>true</code>, ignore "broken link" problems
     *  
     * @return the resources with problems
     * 
     * @throws CmsRpcException  if something goes wrong
     */
    List<CmsPublishResource> publishResources(List<CmsUUID> toPublish, List<CmsUUID> toRemove, boolean force)
    throws CmsRpcException;

}