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.ade.publish.shared.rpc;
029
030import org.opencms.ade.publish.shared.CmsPublishData;
031import org.opencms.ade.publish.shared.CmsPublishGroupList;
032import org.opencms.ade.publish.shared.CmsPublishOptions;
033import org.opencms.ade.publish.shared.CmsWorkflow;
034import org.opencms.ade.publish.shared.CmsWorkflowAction;
035import org.opencms.ade.publish.shared.CmsWorkflowActionParams;
036import org.opencms.ade.publish.shared.CmsWorkflowResponse;
037
038import java.util.HashMap;
039
040import com.google.gwt.user.client.rpc.AsyncCallback;
041
042/**
043 * The asynchronous interface to the publish service.<p>
044 *
045 * @since 8.0.0
046 */
047public interface I_CmsPublishServiceAsync {
048
049    /**
050     * Executes a workflow action.<p>
051     *
052     * @param action the workflow action
053     * @param params the workflow parameters
054     * @param callback the result callback
055     */
056    void executeAction(
057        CmsWorkflowAction action,
058        CmsWorkflowActionParams params,
059        AsyncCallback<CmsWorkflowResponse> callback);
060
061    /**
062     * Asynchronous version of {@link I_CmsPublishService#getInitData(HashMap)}.<p>
063     *
064     * @param params the additional publish parameters
065     * @param callback the result callback
066     */
067    void getInitData(HashMap<String, String> params, AsyncCallback<CmsPublishData> callback);
068
069    /**
070     * Asynchronous version of {@link I_CmsPublishService#getResourceGroups(CmsWorkflow,CmsPublishOptions,boolean)}.<p>
071     *
072     * @param workflow the selected workflow
073     * @param options the publish list options
074     * @param callback the result callback
075     * @param projectChanged indicates whether the reason we get the resource groups is because the user changed the project
076     */
077    void getResourceGroups(
078        CmsWorkflow workflow,
079        CmsPublishOptions options,
080        boolean projectChanged,
081        AsyncCallback<CmsPublishGroupList> callback);
082
083    /**
084     * Asynchronous version of {@link I_CmsPublishService#getResourceOptions()}.<p>
085     *
086     * @param callback the result callback
087     */
088    void getResourceOptions(AsyncCallback<CmsPublishOptions> callback);
089
090}