I_CmsPreviewService.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.galleries.shared.rpc;

import org.opencms.ade.galleries.shared.CmsImageInfoBean;
import org.opencms.ade.galleries.shared.CmsResourceInfoBean;
import org.opencms.gwt.CmsRpcException;

import java.util.Map;

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

/**
 * Handles the common RPC services related to the gallery preview dialog.<p>
 * 
 * @since 8.0.0
 * 
 * @see org.opencms.ade.galleries.CmsPreviewService
 * @see org.opencms.ade.galleries.shared.rpc.I_CmsPreviewService
 * @see org.opencms.ade.galleries.shared.rpc.I_CmsPreviewServiceAsync
 */
public interface I_CmsPreviewService extends RemoteService {

    /**
     * Returns the image resource data to be displayed in the preview dialog.<p>
     * 
     * @param resourcePath the resource path
     * @param locale the content locale
     * 
     * @return the image resource data
     * 
     * @throws CmsRpcException  if something goes wrong
     */
    CmsImageInfoBean getImageInfo(String resourcePath, String locale) throws CmsRpcException;

    /**
     * Returns the data to be displayed in the preview dialog.<p>
     * 
     * @param resourcePath the path to the selected resource
     * @param locale the content locale
     * 
     * @return the preview data
     *   
     * @throws CmsRpcException if something goes wrong
     */
    CmsResourceInfoBean getResourceInfo(String resourcePath, String locale) throws CmsRpcException;

    /**
     * Returns the image resource data to be displayed in the preview dialog.<p>
     * 
     * @param resourcePath the resource path
     * @param locale the content locale
     * 
     * @return the image resource data
     * 
     * @throws CmsRpcException  if something goes wrong
     */
    CmsImageInfoBean syncGetImageInfo(String resourcePath, String locale) throws CmsRpcException;

    /**
     * Saves the given properties to the resource and returns the data to be displayed in the preview dialog.<p>
     * 
     * @param resourcePath the path to the selected resource
     * @param locale the content locale
     * @param properties a map with the key/value pairs of the properties to be updated
     * 
     * @return the updates preview data
     *   
     * @throws CmsRpcException if something goes wrong
     */
    CmsImageInfoBean updateImageProperties(String resourcePath, String locale, Map<String, String> properties)
    throws CmsRpcException;

    /**
     * Saves the given properties to the resource and returns the data to be displayed in the preview dialog.<p>
     * 
     * @param resourcePath the path to the selected resource
     * @param locale the content locale
     * @param properties a map with the key/value pairs of the properties to be updated
     * 
     * @return the updates preview data
     *   
     * @throws CmsRpcException if something goes wrong
     */
    CmsResourceInfoBean updateResourceProperties(String resourcePath, String locale, Map<String, String> properties)
    throws CmsRpcException;

}