org.opencms.gwt

类 CmsVfsService

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

com.google.gwt.user.server.rpc.RemoteServiceServlet

org.opencms.gwt.CmsGwtService

org.opencms.gwt.CmsVfsService

所有已实现的接口:

com.google.gwt.user.client.rpc.RemoteService, com.google.gwt.user.server.rpc.SerializationPolicyProvider, java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, I_CmsVfsService

public class CmsVfsService
extends CmsGwtService
implements I_CmsVfsService

A service class for reading the VFS tree.

从以下版本开始:

8.0.0

另请参阅:

序列化表格

字段概要

从类继承的字段 com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

perThreadRequest, perThreadResponse

构造器概要

构造器

构造器和说明
CmsVfsService()

方法概要

方法

限定符和类型	方法和说明
static CmsListInfoBean	addLockInfo(CmsObject cms, CmsResource resource, CmsListInfoBean resourceInfo) Adds the lock state information to the resource info bean.
protected java.util.Map<java.lang.String,CmsClientProperty>	convertProperties(java.util.List<CmsProperty> properties) Converts CmsProperty objects to CmsClientProperty objects.
void	createPropertyDefinition(java.lang.String name) Creates a new property definition.
protected CmsBrokenLinkBean	createSitemapBrokenLinkBean(CmsResource resource) Creates a "broken link" bean based on a resource.
void	deleteResource(CmsUUID structureId) Deletes a resource from the VFS.
void	deleteResource(java.lang.String sitePath) Deletes a resource from the VFS.
void	forceUnlock(CmsUUID structureId) Forces a resource to be unlocked.
static java.lang.String	formatDateTime(CmsObject cms, long date) Formats a date given the current user's workplace locale.
java.util.List<CmsAliasBean>	getAliasesForPage(CmsUUID uuid) Fetches the aliases for a given page.
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(CmsUUID structureId) Returns a list of potentially broken links, if the given resource was deleted.
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.
java.util.Map<CmsUUID,java.util.Map<java.lang.String,CmsXmlContentProperty>>	getDefaultProperties(java.util.List<CmsUUID> structureIds) Gets the default property configurations for the given structure ids.
protected java.util.Map<java.lang.String,CmsXmlContentProperty>	getDefaultPropertiesForType(java.lang.String typeName) Helper method to get the default property configuration for the given resource type.
java.util.ArrayList<java.lang.String>	getDefinedProperties() Gets the names of defined properties.
CmsReplaceInfo	getFileReplaceInfo(CmsUUID structureId) Returns the file replace info.
CmsLockReportInfo	getLockReportInfo(CmsUUID structureId) Returns the lock report info.
static java.lang.String	getNoPreviewReason(CmsObject cms, CmsResource resource) Returns the no preview reason if there is any.
static CmsListInfoBean	getPageInfo(CmsObject cms, CmsResource res) Gets page information of a resource.
CmsListInfoBean	getPageInfo(CmsUUID structureId) Returns a CmsListInfoBean for a given resource.
CmsListInfoBean	getPageInfo(java.lang.String vfsPath) Returns a CmsListInfoBean for a given resource.
static CmsListInfoBean	getPageInfoWithLock(CmsObject cms, CmsResource resource) Returns a bean to display the CmsListItemWidget including the lock state.
CmsPreviewInfo	getPreviewInfo(CmsUUID structureId, java.lang.String locale) Returns the preview info for the given resource.
CmsPreviewInfo	getPreviewInfo(java.lang.String sitePath, java.lang.String locale) Returns the preview info for the given resource.
CmsRenameInfoBean	getRenameInfo(CmsUUID structureId) Gets the information necessary for the rename dialog.
CmsResourceStatusBean	getResourceStatus(CmsUUID structureId, java.lang.String contentLocale, boolean includeTargets, java.util.List<CmsUUID> additionalTargets) Gets a bean containing status information for a given resource.
CmsRestoreInfoBean	getRestoreInfo(CmsUUID structureId) Gets the information which is necessary for opening the 'Restore' dialog for a 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.
protected java.util.Map<CmsUUID,java.util.Map<java.lang.String,CmsXmlContentProperty>>	internalGetDefaultProperties(java.util.List<CmsUUID> structureIds) Internal method for computing the default property configurations for a list of structure ids.
protected void	internalSaveProperties(CmsPropertyChangeSet changes) Saves a set of property changes.
void	internalUpdateProperties(CmsObject cms, CmsResource ownRes, java.util.List<CmsPropertyModification> propertyModifications) Updates properties for a resource and possibly its detail page.
CmsPropertiesBean	loadPropertyData(CmsUUID id) Load the data necessary to edit the properties of a resource.
protected CmsVfsEntryBean	makeEntryBean(CmsResource resource, boolean root) Helper method for creating a VFS entry bean from a resource.
protected java.util.List<CmsVfsEntryBean>	makeEntryBeans(java.util.List<CmsResource> resources, boolean root) Helper method for creating a list of VFS entry beans from a list of the corresponding resources.
CmsPrepareEditResponse	prepareEdit(CmsUUID currentPageId, java.lang.String pathWithMacros) Prepares to edit a file in the XML content editor.
static java.lang.String	prepareFileNameForEditor(CmsObject cms, CmsResource res, java.lang.String pathWithMacros) Processes a file path, which may have macros in it, so it can be opened by the XML content editor.
java.lang.String	renameResource(CmsUUID structureId, java.lang.String newName) Renames a resource.
java.lang.String	renameResourceInternal(CmsUUID structureId, java.lang.String newName) Internal implementation for renaming a resource.
void	saveAliases(CmsUUID structureId, java.util.List<CmsAliasBean> aliasBeans) Saves aliases for a page.
void	saveProperties(CmsPropertyChangeSet changes) Saves a set of property changes.
void	setCms(CmsObject cms) Sets the current cms context.
java.lang.String	substituteLinkForRootPath(java.lang.String currentSiteRoot, java.lang.String rootPath) Returns the absolute link to the given root path.
void	syncDeleteResource(CmsUUID structureId) Deletes a resource from the VFS.
void	undoChanges(CmsUUID structureId, boolean undoMove) Undoes the changes to a given resource, i.e. restores its online content to its offline version.
java.util.Map<java.lang.String,java.lang.String>	validateAliases(CmsUUID uuid, java.util.Map<java.lang.String,java.lang.String> aliasPaths) Validates alias paths for a page.

从类继承的方法 org.opencms.gwt.CmsGwtService

checkPermissions, clearThreadStorage, doGetSerializationPolicy, doUnexpectedFailure, ensureLock, ensureLock, ensureLock, ensureSession, error, getCmsObject, getPropertiesByName, getRequest, getResponse, log, log, logError, service, setContext, setRequest, setResponse, tryUnlock

从类继承的方法 com.google.gwt.user.server.rpc.RemoteServiceServlet

checkPermutationStrongName, getSerializationPolicy, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processPost, shouldCompressResponse

从类继承的方法 com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

doPost, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

从类继承的方法 javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service

从类继承的方法 javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

CmsVfsService

public CmsVfsService()

方法详细资料

addLockInfo

public static CmsListInfoBean addLockInfo(CmsObject cms,
                          CmsResource resource,
                          CmsListInfoBean resourceInfo)
                                   throws CmsException

Adds the lock state information to the resource info bean.

参数:

cms - the CMS context

resource - the resource to get the page info for

resourceInfo - the resource info to add the lock state to

返回:

the resource info bean

抛出:

CmsException - if something else goes wrong

formatDateTime

public static java.lang.String formatDateTime(CmsObject cms,
                              long date)

Formats a date given the current user's workplace locale.

参数:

cms - the current CMS context

date - the date to format

返回:

the formatted date

getNoPreviewReason

public static java.lang.String getNoPreviewReason(CmsObject cms,
                                  CmsResource resource)

Returns the no preview reason if there is any.

参数:

cms - the current cms context

resource - the resource to check

返回:

the no preview reason if there is any

getPageInfo

public static CmsListInfoBean getPageInfo(CmsObject cms,
                          CmsResource res)
                                   throws CmsException,
                                          CmsLoaderException

Gets page information of a resource.

参数:

cms - the CMS context

res - the resource

返回:

gets the page information for the given resource

抛出:

CmsException

CmsLoaderException

getPageInfoWithLock

public static CmsListInfoBean getPageInfoWithLock(CmsObject cms,
                                  CmsResource resource)
                                           throws CmsLoaderException,
                                                  CmsException

Returns a bean to display the CmsListItemWidget including the lock state.

参数:

cms - the CMS context

resource - the resource to get the page info for

返回:

a bean to display the CmsListItemWidget.

抛出:

CmsLoaderException - if the resource type could not be found

CmsException - if something else goes wrong

prepareFileNameForEditor

public static java.lang.String prepareFileNameForEditor(CmsObject cms,
                                        CmsResource res,
                                        java.lang.String pathWithMacros)

Processes a file path, which may have macros in it, so it can be opened by the XML content editor.

参数:

cms - the current CMS context

res - the resource for which the context menu option has been selected

pathWithMacros - the file path which may contain macros

返回:

the processed file path

createPropertyDefinition

public void createPropertyDefinition(java.lang.String name)
                              throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Creates a new property definition.

指定者:

createPropertyDefinition 在接口中 I_CmsVfsService

参数:

name - the name of the property

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.createPropertyDefinition(java.lang.String)

deleteResource

public void deleteResource(CmsUUID structureId)
                    throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Deletes a resource from the VFS.

指定者:

deleteResource 在接口中 I_CmsVfsService

参数:

structureId - the structure id of the resource to delete

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.deleteResource(org.opencms.util.CmsUUID)

deleteResource

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

从接口复制的说明: I_CmsVfsService

Deletes a resource from the VFS.

指定者:

deleteResource 在接口中 I_CmsVfsService

参数:

sitePath - the site path of the resource to delete

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.deleteResource(java.lang.String)

forceUnlock

public void forceUnlock(CmsUUID structureId)
                 throws CmsRpcException

从接口复制的说明: I_CmsVfsService

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

指定者:

forceUnlock 在接口中 I_CmsVfsService

参数:

structureId - the structure id of the resource to unlock

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.forceUnlock(org.opencms.util.CmsUUID)

getAliasesForPage

public java.util.List<CmsAliasBean> getAliasesForPage(CmsUUID uuid)
                                               throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Fetches the aliases for a given page.

指定者:

getAliasesForPage 在接口中 I_CmsVfsService

参数:

uuid - the structure id of the page

返回:

the lists of aliases for the page

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.getAliasesForPage(org.opencms.util.CmsUUID)

getAvailabilityInfo

public CmsAvailabilityInfoBean getAvailabilityInfo(CmsUUID structureId)
                                            throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Returns a CmsAvailabilityInfoBean for a given resource.

指定者:

getAvailabilityInfo 在接口中 I_CmsVfsService

参数:

structureId - the structure id to create the CmsAvailabilityInfoBean for

返回:

the CmsAvailabilityInfoBean for a given resource

抛出:

CmsRpcException - if the RPC call goes wrong

另请参阅:

I_CmsVfsService.getAvailabilityInfo(org.opencms.util.CmsUUID)

getAvailabilityInfo

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

从接口复制的说明: I_CmsVfsService

Returns a CmsAvailabilityInfoBean for a given resource.

指定者:

getAvailabilityInfo 在接口中 I_CmsVfsService

参数:

vfsPath - the vfs path to create the CmsAvailabilityInfoBean for

返回:

the CmsAvailabilityInfoBean for a given resource

抛出:

CmsRpcException - if the RPC call goes wrong

另请参阅:

I_CmsVfsService.getAvailabilityInfo(java.lang.String)

getBrokenLinks

public CmsDeleteResourceBean getBrokenLinks(CmsUUID structureId)
                                     throws CmsRpcException

从接口复制的说明: I_CmsVfsService

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

指定者:

getBrokenLinks 在接口中 I_CmsVfsService

参数:

structureId - the resource structure id

返回:

a list of potentially broken links

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.getBrokenLinks(org.opencms.util.CmsUUID)

getBrokenLinks

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

从接口复制的说明: I_CmsVfsService

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

指定者:

getBrokenLinks 在接口中 I_CmsVfsService

参数:

sitePath - the resource site-path

返回:

a list of potentially broken links

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.getBrokenLinks(java.lang.String)

getChildren

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

从接口复制的说明: I_CmsVfsService

Fetches the list of children of a path.

指定者:

getChildren 在接口中 I_CmsVfsService

参数:

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

返回:

the children of the path

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.getChildren(java.lang.String)

getDefaultProperties

public java.util.Map<CmsUUID,java.util.Map<java.lang.String,CmsXmlContentProperty>> getDefaultProperties(java.util.List<CmsUUID> structureIds)
                                                                                                  throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Gets the default property configurations for the given structure ids.

指定者:

getDefaultProperties 在接口中 I_CmsVfsService

参数:

structureIds - the structure ids for which the property configurations should be fetched

返回:

a map from the given structure ids to their default property configurations

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.getDefaultProperties(java.util.List)

getDefinedProperties

public java.util.ArrayList<java.lang.String> getDefinedProperties()
                                                           throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Gets the names of defined properties.

指定者:

getDefinedProperties 在接口中 I_CmsVfsService

返回:

the list of names for all defined properties

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.getDefinedProperties()

getFileReplaceInfo

public CmsReplaceInfo getFileReplaceInfo(CmsUUID structureId)
                                  throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Returns the file replace info.

指定者:

getFileReplaceInfo 在接口中 I_CmsVfsService

参数:

structureId - the structure id of the file to replace

返回:

the file replace info

抛出:

CmsRpcException - if the RPC call goes wrong

另请参阅:

I_CmsVfsService.getFileReplaceInfo(org.opencms.util.CmsUUID)

getLockReportInfo

public CmsLockReportInfo getLockReportInfo(CmsUUID structureId)
                                    throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Returns the lock report info.

指定者:

getLockReportInfo 在接口中 I_CmsVfsService

参数:

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

返回:

the lock report info

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.getLockReportInfo(org.opencms.util.CmsUUID)

getPageInfo

public CmsListInfoBean getPageInfo(CmsUUID structureId)
                            throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Returns a CmsListInfoBean for a given resource.

指定者:

getPageInfo 在接口中 I_CmsVfsService

参数:

structureId - the structure id to create the CmsListInfoBean for

返回:

the CmsListInfoBean for a given resource

抛出:

CmsRpcException - if the RPC call goes wrong

另请参阅:

I_CmsVfsService.getPageInfo(org.opencms.util.CmsUUID)

getPageInfo

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

从接口复制的说明: I_CmsVfsService

Returns a CmsListInfoBean for a given resource.

指定者:

getPageInfo 在接口中 I_CmsVfsService

参数:

vfsPath - the vfs path to create the CmsListInfoBean for

返回:

the CmsListInfoBean for a given resource

抛出:

CmsRpcException - if the RPC call goes wrong

另请参阅:

I_CmsVfsService.getPageInfo(java.lang.String)

getPreviewInfo

public CmsPreviewInfo getPreviewInfo(CmsUUID structureId,
                            java.lang.String locale)
                              throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Returns the preview info for the given resource.

指定者:

getPreviewInfo 在接口中 I_CmsVfsService

参数:

structureId - the resource structure id

locale - the requested locale

返回:

the preview info

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.getPreviewInfo(org.opencms.util.CmsUUID, java.lang.String)

getPreviewInfo

public CmsPreviewInfo getPreviewInfo(java.lang.String sitePath,
                            java.lang.String locale)
                              throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Returns the preview info for the given resource.

指定者:

getPreviewInfo 在接口中 I_CmsVfsService

参数:

sitePath - the resource site path

locale - the requested locale

返回:

the preview info

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.getPreviewInfo(java.lang.String, java.lang.String)

getRenameInfo

public CmsRenameInfoBean getRenameInfo(CmsUUID structureId)
                                throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Gets the information necessary for the rename dialog.

指定者:

getRenameInfo 在接口中 I_CmsVfsService

参数:

structureId - the structure id of the resource to rename

返回:

the information needed for the rename dialog

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.getRenameInfo(org.opencms.util.CmsUUID)

getResourceStatus

public CmsResourceStatusBean getResourceStatus(CmsUUID structureId,
                                      java.lang.String contentLocale,
                                      boolean includeTargets,
                                      java.util.List<CmsUUID> additionalTargets)
                                        throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Gets a bean containing status information for a given resource.

指定者:

getResourceStatus 在接口中 I_CmsVfsService

参数:

structureId - the structure id of a resource

contentLocale - the locale for which we want the resource information

includeTargets - true if relation targets should also be fetched

additionalTargets - structure ids of resources to add to the relation targets returned

返回:

the resource status

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.getResourceStatus(org.opencms.util.CmsUUID, java.lang.String, boolean, java.util.List)

getRestoreInfo

public CmsRestoreInfoBean getRestoreInfo(CmsUUID structureId)
                                  throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Gets the information which is necessary for opening the 'Restore' dialog for a resource.

指定者:

getRestoreInfo 在接口中 I_CmsVfsService

参数:

structureId - the structure id of the resource

返回:

the information for the resource

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.getRestoreInfo(org.opencms.util.CmsUUID)

getRootEntries

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

从接口复制的说明: I_CmsVfsService

Returns the root entries of the VFS.

指定者:

getRootEntries 在接口中 I_CmsVfsService

返回:

a list of root entries

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.getRootEntries()

getSitePath

public java.lang.String getSitePath(CmsUUID structureId)

从接口复制的说明: I_CmsVfsService

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

指定者:

getSitePath 在接口中 I_CmsVfsService

参数:

structureId - the structure id

返回:

the site-path or null if not available

另请参阅:

I_CmsVfsService.getSitePath(org.opencms.util.CmsUUID)

internalUpdateProperties

public void internalUpdateProperties(CmsObject cms,
                            CmsResource ownRes,
                            java.util.List<CmsPropertyModification> propertyModifications)
                              throws CmsException

Updates properties for a resource and possibly its detail page.

参数:

cms - the CMS context

ownRes - the resource

propertyModifications - the property modifications

抛出:

CmsException - if something goes wrong

loadPropertyData

public CmsPropertiesBean loadPropertyData(CmsUUID id)
                                   throws CmsRpcException

从接口复制的说明: I_CmsVfsService

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

指定者:

loadPropertyData 在接口中 I_CmsVfsService

参数:

id - the structure id of a resource

返回:

the property information for that resource

抛出:

CmsRpcException

另请参阅:

I_CmsVfsService.loadPropertyData(org.opencms.util.CmsUUID)

prepareEdit

public CmsPrepareEditResponse prepareEdit(CmsUUID currentPageId,
                                 java.lang.String pathWithMacros)
                                   throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Prepares to edit a file in the XML content editor.

指定者:

prepareEdit 在接口中 I_CmsVfsService

参数:

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

pathWithMacros - the file name, which may contain macros

返回:

a bean with more information about the file to edit

抛出:

CmsRpcException

另请参阅:

I_CmsVfsService.prepareEdit(org.opencms.util.CmsUUID, java.lang.String)

renameResource

public java.lang.String renameResource(CmsUUID structureId,
                              java.lang.String newName)
                                throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Renames a resource.

指定者:

renameResource 在接口中 I_CmsVfsService

参数:

structureId - the structure id of the resource to rename

newName - the new resource name

返回:

null or an error message

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.renameResource(org.opencms.util.CmsUUID, java.lang.String)

renameResourceInternal

public java.lang.String renameResourceInternal(CmsUUID structureId,
                                      java.lang.String newName)
                                        throws CmsException

Internal implementation for renaming a resource.

参数:

structureId - the structure id of the resource to rename

newName - the new resource name

返回:

either null if the rename was successful, or an error message

抛出:

CmsException - if something goes wrong

saveAliases

public void saveAliases(CmsUUID structureId,
               java.util.List<CmsAliasBean> aliasBeans)
                 throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Saves aliases for a page.

指定者:

saveAliases 在接口中 I_CmsVfsService

参数:

structureId - the structure id of the page

aliasBeans - the aliases which should be saved for the page

抛出:

CmsRpcException

另请参阅:

I_CmsVfsService.saveAliases(org.opencms.util.CmsUUID, java.util.List)

saveProperties

public void saveProperties(CmsPropertyChangeSet changes)
                    throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Saves a set of property changes.

指定者:

saveProperties 在接口中 I_CmsVfsService

参数:

changes - a set of property changes

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.saveProperties(org.opencms.gwt.shared.property.CmsPropertyChangeSet)

setCms

public void setCms(CmsObject cms)

Sets the current cms context.

覆盖:

setCms 在类中 CmsGwtService

参数:

cms - the current cms context to set

substituteLinkForRootPath

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

从接口复制的说明: I_CmsVfsService

Returns the absolute link to the given root path.

指定者:

substituteLinkForRootPath 在接口中 I_CmsVfsService

参数:

currentSiteRoot - the current site

rootPath - the root path

返回:

the absolute link

抛出:

CmsRpcException - if something goes wrong processing the request

另请参阅:

I_CmsVfsService.substituteLinkForRootPath(java.lang.String, java.lang.String)

syncDeleteResource

public void syncDeleteResource(CmsUUID structureId)
                        throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Deletes a resource from the VFS.

指定者:

syncDeleteResource 在接口中 I_CmsVfsService

参数:

structureId - the structure id of the resource to delete

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.syncDeleteResource(org.opencms.util.CmsUUID)

undoChanges

public void undoChanges(CmsUUID structureId,
               boolean undoMove)
                 throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Undoes the changes to a given resource, i.e. restores its online content to its offline version.

指定者:

undoChanges 在接口中 I_CmsVfsService

参数:

structureId - the structure id of the resource to undo

undoMove - true if move operations should be undone

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.undoChanges(org.opencms.util.CmsUUID, boolean)

validateAliases

public java.util.Map<java.lang.String,java.lang.String> validateAliases(CmsUUID uuid,
                                                               java.util.Map<java.lang.String,java.lang.String> aliasPaths)
                                                                 throws CmsRpcException

从接口复制的说明: I_CmsVfsService

Validates alias paths for a page.

指定者:

validateAliases 在接口中 I_CmsVfsService

参数:

uuid - the structure id of the page

aliasPaths - a map from (arbitrary) id strings to alias paths

返回:

a map which maps the same id strings to validation results

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsVfsService.validateAliases(org.opencms.util.CmsUUID, java.util.Map)

convertProperties

protected java.util.Map<java.lang.String,CmsClientProperty> convertProperties(java.util.List<CmsProperty> properties)

Converts CmsProperty objects to CmsClientProperty objects.

参数:

properties - a list of server-side properties

返回:

a map of client-side properties

createSitemapBrokenLinkBean

protected CmsBrokenLinkBean createSitemapBrokenLinkBean(CmsResource resource)
                                                 throws CmsException

Creates a "broken link" bean based on a resource.

参数:

resource - the resource

返回:

the "broken link" bean with the data from the resource

抛出:

CmsException - if something goes wrong

getDefaultPropertiesForType

protected java.util.Map<java.lang.String,CmsXmlContentProperty> getDefaultPropertiesForType(java.lang.String typeName)

Helper method to get the default property configuration for the given resource type.

参数:

typeName - the name of the resource type

返回:

the default property configuration for the given type

internalGetDefaultProperties

protected java.util.Map<CmsUUID,java.util.Map<java.lang.String,CmsXmlContentProperty>> internalGetDefaultProperties(java.util.List<CmsUUID> structureIds)
                                                                                                             throws CmsException

Internal method for computing the default property configurations for a list of structure ids.

参数:

structureIds - the structure ids for which we want the default property configurations

返回:

a map from the given structure ids to their default property configurations

抛出:

CmsException - if something goes wrong

internalSaveProperties

protected void internalSaveProperties(CmsPropertyChangeSet changes)
                               throws CmsException

Saves a set of property changes.

参数:

changes - the set of property changes

抛出:

CmsException - if something goes wrong

makeEntryBean

protected CmsVfsEntryBean makeEntryBean(CmsResource resource,
                            boolean root)
                                 throws CmsException

Helper method for creating a VFS entry bean from a resource.

参数:

resource - the resource whose data should be stored in the bean

root - true if the resource is a root resource

返回:

the data bean representing the resource

抛出:

CmsException - if something goes wrong

makeEntryBeans

protected java.util.List<CmsVfsEntryBean> makeEntryBeans(java.util.List<CmsResource> resources,
                                             boolean root)
                                                  throws CmsException

Helper method for creating a list of VFS entry beans from a list of the corresponding resources.

参数:

resources - the list of resources which should be converted to entry beans

root - true if the resources in the list are root resources

返回:

the list of VFS entry beans for the resources

抛出:

CmsException - if something goes wrong