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

public interface I_CmsGalleryServiceAsync

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, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Deletes the given resource.
void	getGalleries(java.util.List<java.lang.String> resourceTypes, com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsGalleryFolderBean>> callback) Returns the available galleries depending on the given resource types.
void	getInfoForResource(java.lang.String path, java.lang.String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsResultItemBean> callback) Returns the resource info for a single resource.
void	getInitialSettings(CmsGalleryConfiguration conf, com.google.gwt.user.client.rpc.AsyncCallback<CmsGalleryDataBean> callback) Returns the initial data for the given gallery mode.
void	getSearch(CmsGalleryDataBean data, com.google.gwt.user.client.rpc.AsyncCallback<CmsGallerySearchBean> callback) Performs an initial search based on the given data bean and the available parameters of the request.
void	getSearch(CmsGallerySearchBean searchObj, com.google.gwt.user.client.rpc.AsyncCallback<CmsGallerySearchBean> callback) Returns the gallery search object containing search results and the currant search parameter.
void	getSubEntries(java.lang.String rootPath, boolean isRoot, com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsSitemapEntryBean>> callback) Returns the sub entries to the given sitemap path.
void	getSubFolders(java.lang.String path, com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsVfsEntryBean>> callback) Gets the sub-folders of a folder.
void	loadVfsEntryBean(java.lang.String path, com.google.gwt.user.client.rpc.AsyncCallback<CmsVfsEntryBean> resultCallback) Loads the root VFS entry bean for the given site root.
void	saveTreeOpenState(java.lang.String treeName, java.lang.String treeToken, java.lang.String siteRoot, java.util.Set<CmsUUID> openItems, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Saves the tree open state.
void	updateIndex(com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Updates the offline indices.

Method Detail

deleteResource

void deleteResource(java.lang.String resourcePath,
                    com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Deletes the given resource.

Parameters:

resourcePath - the resource path of the resource to delete

callback - the callback

getGalleries

void getGalleries(java.util.List<java.lang.String> resourceTypes,
                  com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsGalleryFolderBean>> callback)

Returns the available galleries depending on the given resource types.

Parameters:

resourceTypes - the resource types

callback - the callback

getInfoForResource

void getInfoForResource(java.lang.String path,
                        java.lang.String locale,
                        com.google.gwt.user.client.rpc.AsyncCallback<CmsResultItemBean> callback)

Returns the resource info for a single resource.

Parameters:

path - the resource path

locale - the content locale

callback - the callback

getInitialSettings

void getInitialSettings(CmsGalleryConfiguration conf,
                        com.google.gwt.user.client.rpc.AsyncCallback<CmsGalleryDataBean> callback)

Returns the initial data for the given gallery mode.

Parameters:

conf - the gallery configuration

callback - the callback

getSearch

void getSearch(CmsGalleryDataBean data,
               com.google.gwt.user.client.rpc.AsyncCallback<CmsGallerySearchBean> callback)

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

Parameters:

data - the data bean

callback - the callback

getSearch

void getSearch(CmsGallerySearchBean searchObj,
               com.google.gwt.user.client.rpc.AsyncCallback<CmsGallerySearchBean> callback)

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

Parameters:

searchObj - the current search object

callback - the callback

getSubEntries

void getSubEntries(java.lang.String rootPath,
                   boolean isRoot,
                   com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsSitemapEntryBean>> callback)

Returns the sub entries to the given sitemap path.

Parameters:

rootPath - the root path

isRoot - true if the requested entry is the root entry

callback - the asynchronous callback

getSubFolders

void getSubFolders(java.lang.String path,
                   com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsVfsEntryBean>> callback)

Gets the sub-folders of a folder.

Parameters:

path - the path of a folder

callback - the asynchronous callback

loadVfsEntryBean

void loadVfsEntryBean(java.lang.String path,
                      com.google.gwt.user.client.rpc.AsyncCallback<CmsVfsEntryBean> resultCallback)

Loads the root VFS entry bean for the given site root.

Parameters:

path - the site root

resultCallback - the callback for the result

saveTreeOpenState

void saveTreeOpenState(java.lang.String treeName,
                       java.lang.String treeToken,
                       java.lang.String siteRoot,
                       java.util.Set<CmsUUID> openItems,
                       com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Saves the tree open state.

Parameters:

treeName - the tree name

treeToken - the tree token

siteRoot - the site root

openItems - the open items

callback - the result callback

updateIndex

void updateIndex(com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Updates the offline indices.

Parameters:

callback - the callback