org.opencms.gwt.shared.rpc
Interface I_CmsVfsServiceAsync

public interface I_CmsVfsServiceAsync

An asynchronous service interface for retrieving information about the VFS tree.

Since:

8.0.0

Method Summary

void	deleteResource(java.lang.String sitePath, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Deletes a resource from the VFS.
void	forceUnlock(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Forces a resource to be unlocked.
void	getAvailabilityInfo(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<CmsAvailabilityInfoBean> callback) Gets a CmsAvailabilityInfoBean for a given resource.
void	getAvailabilityInfo(java.lang.String vfsPath, com.google.gwt.user.client.rpc.AsyncCallback<CmsAvailabilityInfoBean> callback) Gets a CmsAvailabilityInfoBean for a given resource.
void	getBrokenLinks(java.lang.String sitePath, com.google.gwt.user.client.rpc.AsyncCallback<CmsDeleteResourceBean> callback) Returns a list of potentially broken links, if the given resource was deleted.
void	getChildren(java.lang.String path, com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsVfsEntryBean>> callback) Fetches the list of children of a path.
void	getLockReportInfo(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<CmsLockReportInfo> callback) Returns the lock report info.
void	getPageInfo(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<CmsListInfoBean> callback) Gets a CmsListInfoBean for a given resource.
void	getPageInfo(java.lang.String vfsPath, com.google.gwt.user.client.rpc.AsyncCallback<CmsListInfoBean> callback) Gets a CmsListInfoBean for a given resource.
void	getRootEntries(com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsVfsEntryBean>> callback) Returns the root entries of the VFS.
void	getSitePath(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.String> callback) Returns the site-path for the resource with the given id.
void	loadPropertyData(CmsUUID id, com.google.gwt.user.client.rpc.AsyncCallback<CmsPropertiesBean> callback) Load the data necessary to edit the properties of a resource.
void	prepareEdit(CmsUUID currentPage, java.lang.String fileNameWithMacros, com.google.gwt.user.client.rpc.AsyncCallback<CmsPrepareEditResponse> callback) Prepares to edit a file in the XML content editor.
void	saveProperties(CmsPropertyChangeSet changes, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback) Saves a set of property changes.
void	substituteLinkForRootPath(java.lang.String currentSiteRoot, java.lang.String rootPath, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.String> callback) Returns the absolute link to the given root path.

Method Detail

deleteResource

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

Deletes a resource from the VFS.

Parameters:

sitePath - the site path of the resource to delete

callback - the callback

forceUnlock

void forceUnlock(CmsUUID structureId,
                 com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Forces a resource to be unlocked. In case the given resource is a folder, all sub-resources are also unlocked.

Parameters:

structureId - the structure id of the resource to unlock

callback - the callback

getAvailabilityInfo

void getAvailabilityInfo(CmsUUID structureId,
                         com.google.gwt.user.client.rpc.AsyncCallback<CmsAvailabilityInfoBean> callback)

Gets a CmsAvailabilityInfoBean for a given resource.

Parameters:

structureId - the structure id to create the CmsAvailabilityInfoBean for

callback - the asynchronous callback

getAvailabilityInfo

void getAvailabilityInfo(java.lang.String vfsPath,
                         com.google.gwt.user.client.rpc.AsyncCallback<CmsAvailabilityInfoBean> callback)

Gets a CmsAvailabilityInfoBean for a given resource.

Parameters:

vfsPath - the vfs path to create the CmsAvailabilityInfoBean for

callback - the asynchronous callback

getBrokenLinks

void getBrokenLinks(java.lang.String sitePath,
                    com.google.gwt.user.client.rpc.AsyncCallback<CmsDeleteResourceBean> callback)

Returns a list of potentially broken links, if the given resource was deleted.

Parameters:

sitePath - the resource site-path

callback - the callback

getChildren

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

Fetches the list of children of a path.

Parameters:

path - the path for which the list of children should be retrieved

callback - the asynchronous callback

getLockReportInfo

void getLockReportInfo(CmsUUID structureId,
                       com.google.gwt.user.client.rpc.AsyncCallback<CmsLockReportInfo> callback)

Returns the lock report info.

Parameters:

structureId - the structure id of the resource to get the report for

callback - the callback

getPageInfo

void getPageInfo(CmsUUID structureId,
                 com.google.gwt.user.client.rpc.AsyncCallback<CmsListInfoBean> callback)

Gets a CmsListInfoBean for a given resource.

Parameters:

structureId - the structure id to create the CmsListInfoBean for

callback - the asynchronous callback

getPageInfo

void getPageInfo(java.lang.String vfsPath,
                 com.google.gwt.user.client.rpc.AsyncCallback<CmsListInfoBean> callback)

Gets a CmsListInfoBean for a given resource.

Parameters:

vfsPath - the vfs path to create the CmsListInfoBean for

callback - the asynchronous callback

getRootEntries

void getRootEntries(com.google.gwt.user.client.rpc.AsyncCallback<java.util.List<CmsVfsEntryBean>> callback)

Returns the root entries of the VFS.

Parameters:

callback - the asynchronous callback

getSitePath

void getSitePath(CmsUUID structureId,
                 com.google.gwt.user.client.rpc.AsyncCallback<java.lang.String> callback)

Returns the site-path for the resource with the given id.

Parameters:

structureId - the structure id

callback - the asynchronous callback

loadPropertyData

void loadPropertyData(CmsUUID id,
                      com.google.gwt.user.client.rpc.AsyncCallback<CmsPropertiesBean> callback)

Load the data necessary to edit the properties of a resource.

Parameters:

id - the structure id of a resource

callback - the asynchronous callback

prepareEdit

void prepareEdit(CmsUUID currentPage,
                 java.lang.String fileNameWithMacros,
                 com.google.gwt.user.client.rpc.AsyncCallback<CmsPrepareEditResponse> callback)

Prepares to edit a file in the XML content editor.

Parameters:

currentPage - the current page from which the editor should be opened

fileNameWithMacros - the file name, which may contain macros

callback - the asynchronous callback

saveProperties

void saveProperties(CmsPropertyChangeSet changes,
                    com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Void> callback)

Saves a set of property changes.

Parameters:

changes - the property changes

callback - the asynchronous callback

substituteLinkForRootPath

@SynchronizedRpcRequest
void substituteLinkForRootPath(java.lang.String currentSiteRoot,
                                                      java.lang.String rootPath,
                                                      com.google.gwt.user.client.rpc.AsyncCallback<java.lang.String> callback)

Returns the absolute link to the given root path.

Parameters:

currentSiteRoot - the current site

rootPath - the root path

callback - the asynchronous callback