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; 037import org.opencms.gwt.CmsRpcException; 038 039import java.util.HashMap; 040 041import com.google.gwt.user.client.rpc.RemoteService; 042 043/** 044 * The synchronous publish list interface.<p> 045 * 046 * @since 8.0.0 047 */ 048public interface I_CmsPublishService extends RemoteService { 049 050 /** 051 * Tries to publish a list of resources.<p> 052 * 053 * @param action the work flow action 054 * @param params the data on which to perform the workflow action 055 * 056 * @return the workflow response 057 * 058 * @throws CmsRpcException if something goes wrong 059 */ 060 CmsWorkflowResponse executeAction(CmsWorkflowAction action, CmsWorkflowActionParams params) throws CmsRpcException; 061 062 /** 063 * Returns the initial publish data.<p> 064 * 065 * @param params a map of additional publish parameters 066 * 067 * @return the initial publish data 068 * 069 * @throws CmsRpcException if something goes wrong 070 */ 071 CmsPublishData getInitData(HashMap<String, String> params) throws CmsRpcException; 072 073 /** 074 * Retrieves the publish list, subdivided into groups based on the time of their last change.<p> 075 * 076 * @param workflow the selected workflow 077 * @param options the publish options for which the publish list should be fetched 078 * @param projectChanged indicates whether the reason we get the resource groups is because the user changed the project 079 * 080 * @return the publish list groups 081 * 082 * @throws CmsRpcException if something goes wrong 083 */ 084 CmsPublishGroupList getResourceGroups(CmsWorkflow workflow, CmsPublishOptions options, boolean projectChanged) 085 throws CmsRpcException; 086 087 /** 088 * Retrieves the publish options.<p> 089 * 090 * @return the publish options last used 091 * 092 * @throws CmsRpcException if something goes wrong 093 */ 094 CmsPublishOptions getResourceOptions() throws CmsRpcException; 095 096}