Package org.opencms.ade.galleries.shared.rpc

Interface I_CmsPreviewService

All Superinterfaces:

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

All Known Implementing Classes:

CmsPreviewService

public interface I_CmsPreviewService
extends com.google.gwt.user.client.rpc.RemoteService

Handles the common RPC services related to the gallery preview dialog.

Since:

8.0.0

See Also:

• CmsPreviewService
• I_CmsPreviewService
• I_CmsPreviewServiceAsync

Method Summary

Modifier and Type	Method	Description
CmsImageInfoBean	getImageInfo(String resourcePath, String locale)	Returns the image resource data to be displayed in the preview dialog.
CmsResourceInfoBean	getResourceInfo(String resourcePath, String locale)	Returns the data to be displayed in the preview dialog.
CmsImageInfoBean	updateImageProperties(String resourcePath, String locale, Map<String,String> properties)	Saves the given properties to the resource and returns the data to be displayed in the preview dialog.
CmsResourceInfoBean	updateResourceProperties(String resourcePath, String locale, Map<String,String> properties)	Saves the given properties to the resource and returns the data to be displayed in the preview dialog.

Method Details

getImageInfo

CmsImageInfoBean getImageInfo(String resourcePath,
 String locale)
                       throws CmsRpcException

Returns the image resource data to be displayed in the preview dialog.

Parameters:

resourcePath - the resource path

locale - the content locale

Returns:

the image resource data

Throws:

CmsRpcException - if something goes wrong

getResourceInfo

CmsResourceInfoBean getResourceInfo(String resourcePath,
 String locale)
                             throws CmsRpcException

Returns the data to be displayed in the preview dialog.

Parameters:

resourcePath - the path to the selected resource

locale - the content locale

Returns:

the preview data

Throws:

CmsRpcException - if something goes wrong

updateImageProperties

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.

Parameters:

resourcePath - the path to the selected resource

locale - the content locale

properties - a map with the key/value pairs of the properties to be updated

Returns:

the updates preview data

Throws:

CmsRpcException - if something goes wrong

updateResourceProperties

CmsResourceInfoBean updateResourceProperties(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.

Parameters:

resourcePath - the path to the selected resource

locale - the content locale

properties - a map with the key/value pairs of the properties to be updated

Returns:

the updates preview data

Throws:

CmsRpcException - if something goes wrong