org.opencms.gwt.shared.rpc
Interface I_CmsVfsService

All Superinterfaces:

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

All Known Implementing Classes:

CmsVfsService

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

A service interface for retrieving information about the VFS tree.

Since:

8.0.0

Method Summary

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

Method Detail

deleteResource

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

Deletes a resource from the VFS.

Parameters:

sitePath - the site path of the resource to delete

Throws:

CmsRpcException - if something goes wrong

forceUnlock

void forceUnlock(CmsUUID structureId)
                 throws CmsRpcException

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

Throws:

CmsRpcException - if something goes wrong

getAvailabilityInfo

CmsAvailabilityInfoBean getAvailabilityInfo(CmsUUID structureId)
                                            throws CmsRpcException

Returns a CmsAvailabilityInfoBean for a given resource.

Parameters:

structureId - the structure id to create the CmsAvailabilityInfoBean for

Returns:

the CmsAvailabilityInfoBean for a given resource

Throws:

CmsRpcException - if the RPC call goes wrong

getAvailabilityInfo

CmsAvailabilityInfoBean getAvailabilityInfo(java.lang.String vfsPath)
                                            throws CmsRpcException

Returns a CmsAvailabilityInfoBean for a given resource.

Parameters:

vfsPath - the vfs path to create the CmsAvailabilityInfoBean for

Returns:

the CmsAvailabilityInfoBean for a given resource

Throws:

CmsRpcException - if the RPC call goes wrong

getBrokenLinks

CmsDeleteResourceBean getBrokenLinks(java.lang.String sitePath)
                                     throws CmsRpcException

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

Parameters:

sitePath - the resource site-path

Returns:

a list of potentially broken links

Throws:

CmsRpcException - if something goes wrong

getChildren

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

Fetches the list of children of a path.

Parameters:

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

Returns:

the children of the path

Throws:

CmsRpcException - if something goes wrong

getLockReportInfo

CmsLockReportInfo getLockReportInfo(CmsUUID structureId)
                                    throws CmsRpcException

Returns the lock report info.

Parameters:

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

Returns:

the lock report info

Throws:

CmsRpcException - if something goes wrong

getPageInfo

CmsListInfoBean getPageInfo(CmsUUID structureId)
                            throws CmsRpcException

Returns a CmsListInfoBean for a given resource.

Parameters:

structureId - the structure id to create the CmsListInfoBean for

Returns:

the CmsListInfoBean for a given resource

Throws:

CmsRpcException - if the RPC call goes wrong

getPageInfo

CmsListInfoBean getPageInfo(java.lang.String vfsPath)
                            throws CmsRpcException

Returns a CmsListInfoBean for a given resource.

Parameters:

vfsPath - the vfs path to create the CmsListInfoBean for

Returns:

the CmsListInfoBean for a given resource

Throws:

CmsRpcException - if the RPC call goes wrong

getRootEntries

java.util.List<CmsVfsEntryBean> getRootEntries()
                                               throws CmsRpcException

Returns the root entries of the VFS.

Returns:

a list of root entries

Throws:

CmsRpcException - if something goes wrong

getSitePath

java.lang.String getSitePath(CmsUUID structureId)
                             throws CmsRpcException

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

Parameters:

structureId - the structure id

Returns:

the site-path or null if not available

Throws:

CmsRpcException - if something goes wrong

loadPropertyData

CmsPropertiesBean loadPropertyData(CmsUUID id)
                                   throws CmsRpcException

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

Parameters:

id - the structure id of a resource

Returns:

the property information for that resource

Throws:

CmsRpcException

prepareEdit

CmsPrepareEditResponse prepareEdit(CmsUUID currentPage,
                                   java.lang.String fileNameWithMacros)
                                   throws CmsRpcException

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

Returns:

a bean with more information about the file to edit

Throws:

CmsRpcException

saveProperties

void saveProperties(CmsPropertyChangeSet changes)
                    throws CmsRpcException

Saves a set of property changes.

Parameters:

changes - a set of property changes

Throws:

CmsRpcException - if something goes wrong

substituteLinkForRootPath

java.lang.String substituteLinkForRootPath(java.lang.String currentSiteRoot,
                                           java.lang.String rootPath)
                                           throws CmsRpcException

Returns the absolute link to the given root path.

Parameters:

currentSiteRoot - the current site

rootPath - the root path

Returns:

the absolute link

Throws:

CmsRpcException - if something goes wrong processing the request