org.opencms.ade.galleries.shared.rpc
Interface I_CmsGalleryService

All Superinterfaces:

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

All Known Implementing Classes:

CmsGalleryService

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

Handles all RPC services related to the gallery dialog.

Since:

8.0.0

See Also:

CmsGalleryService, I_CmsGalleryService, I_CmsGalleryServiceAsync

Method Summary

void	deleteResource(java.lang.String resourcePath) Deletes the given resource.
java.util.List<CmsGalleryFolderBean>	getGalleries(java.util.List<java.lang.String> resourceTypes) Returns the available galleries depending on the given resource types.
CmsGalleryDataBean	getInitialSettings() Returns the initial data for the given gallery mode.
CmsGallerySearchBean	getSearch(CmsGalleryDataBean data) Performs an initial search based on the given data bean and the available parameters of the request.
CmsGallerySearchBean	getSearch(CmsGallerySearchBean searchObj) Returns the gallery search object containing search results and the currant search parameter.
java.util.List<CmsVfsEntryBean>	getSubFolders(java.lang.String path) Gets the sub-folders of a folder.

Method Detail

deleteResource

void deleteResource(java.lang.String resourcePath)
                    throws CmsRpcException

Deletes the given resource.

Parameters:

resourcePath - the resource path of the resource to delete

Throws:

CmsRpcException - if something goes wrong

getGalleries

java.util.List<CmsGalleryFolderBean> getGalleries(java.util.List<java.lang.String> resourceTypes)
                                                  throws CmsRpcException

Returns the available galleries depending on the given resource types.

Parameters:

resourceTypes - the resource types

Returns:

the galleries

Throws:

CmsRpcException - if something goes wrong

getInitialSettings

CmsGalleryDataBean getInitialSettings()
                                      throws CmsRpcException

Returns the initial data for the given gallery mode.

Returns:

the data bean

Throws:

CmsRpcException - if something goes wrong

getSearch

CmsGallerySearchBean getSearch(CmsGalleryDataBean data)
                               throws CmsRpcException

Performs an initial search based on the given data bean and the available parameters of the request.

Parameters:

data - the data bean

Returns:

the search result

Throws:

CmsRpcException - if something goes wrong

getSearch

CmsGallerySearchBean getSearch(CmsGallerySearchBean searchObj)
                               throws CmsRpcException

Returns the gallery search object containing search results and the currant search parameter.

Parameters:

searchObj - the current search object

Returns:

the search object containing search results

Throws:

CmsRpcException - is something goes wrong

getSubFolders

java.util.List<CmsVfsEntryBean> getSubFolders(java.lang.String path)
                                              throws CmsRpcException

Gets the sub-folders of a folder.

Parameters:

path - the path of a folder

Returns:

beans representing the sub-folders of the folder

Throws:

CmsRpcException - if something goes wrong