Package 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 Details

    • createNewExternalLink

      void createNewExternalLink(String title, String link, String resourceName, String parentFolderPath, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Creates a new external link resource.

      Parameters:
      title - the title
      link - the link
      resourceName - the name of the link resource to create
      parentFolderPath - the parent folder site path
      callback - the async callback

    • createPropertyDefinition

      void createPropertyDefinition(String propertyName, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Creates a property definition.

      Parameters:
      propertyName - the new property name
      callback - the callback

    • deleteResource

      void deleteResource(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Deletes a resource from the VFS.

      Parameters:
      structureId - the structure id of the resource to delete
      callback - the callback

    • deleteResource

      void deleteResource(String sitePath, com.google.gwt.user.client.rpc.AsyncCallback<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<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

    • getAliasesForPage

      void getAliasesForPage(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<List<CmsAliasBean>> callback)
      Fetches the aliases for a given page.

      Parameters:
      structureId - the structure id of the page
      callback - the async callback

    • getBrokenLinks

      void getBrokenLinks(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<CmsDeleteResourceBean> callback)
      Returns a list of potentially broken links, if the given resource was deleted.

      Parameters:
      structureId - the resource structure id
      callback - the callback

    • getBrokenLinks

      void getBrokenLinks(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(String path, com.google.gwt.user.client.rpc.AsyncCallback<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

    • getDataViewThumbnail

      void getDataViewThumbnail(String config, String id, com.google.gwt.user.client.rpc.AsyncCallback<String> imageCallback)
      Loads a thumbnail for the given dataview configuration and id.

      Parameters:
      config - the dataview configuration
      id - the data id
      imageCallback - the callback to be called with the result URL

    • getDefaultProperties

      void getDefaultProperties(List<CmsUUID> structureIds, com.google.gwt.user.client.rpc.AsyncCallback<Map<CmsUUID,Map<String,CmsXmlContentProperty>>> callback)
      Gets the default property configurations for a list of structure ids.

      Parameters:
      structureIds - the structure ids for which to fetch the default property configurations
      callback - the callback for the result

    • getDefinedProperties

      void getDefinedProperties(com.google.gwt.user.client.rpc.AsyncCallback<ArrayList<String>> callback)
      Gets the names of defined properties.

      Parameters:
      callback - the callback for the results

    • getDetailName

      void getDetailName(CmsUUID id, String localeStr, com.google.gwt.user.client.rpc.AsyncCallback<String> callback)
      Gets the detail name for the given structure id.
      Parameters:
      id - a structure id
      localeStr - the locale as a string
      callback - the callback for the result

    • getFileReplaceInfo

      void getFileReplaceInfo(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<CmsReplaceInfo> callback)
      Returns the file replace info.

      Parameters:
      structureId - the structure id of the file to replace
      callback - the asynchronous callback

    • getHistoryPreviewInfo

      void getHistoryPreviewInfo(CmsUUID structureId, String locale, CmsHistoryVersion version, com.google.gwt.user.client.rpc.AsyncCallback<CmsPreviewInfo> resultCallback)
      Gets th historical preview information for the given resource.

      Parameters:
      structureId - the structure id of the resource
      locale - the locale for which to get the preview info
      version - thee version for which to get the preview information
      resultCallback - if something goe

    • 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(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

    • getPreviewInfo

      void getPreviewInfo(CmsUUID structureId, String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsPreviewInfo> callback)
      Returns the preview info for the given resource.

      Parameters:
      structureId - the resource structure id
      locale - the requested locale
      callback - the call back

    • getPreviewInfo

      void getPreviewInfo(String sitePath, String locale, com.google.gwt.user.client.rpc.AsyncCallback<CmsPreviewInfo> callback)
      Returns the preview info for the given resource.

      Parameters:
      sitePath - the resource site path
      locale - the requested locale
      callback - the call back

    • getRenameInfo

      void getRenameInfo(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<CmsRenameInfoBean> callback)
      Gets the information needed for the Rename dialog.

      Parameters:
      structureId - the structure id of the resource to rename
      callback - the callback for the result

    • getResourceHistory

      void getResourceHistory(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<CmsHistoryResourceCollection> resultCallback)
      Gets the history of a resource.

      Parameters:
      structureId - the structure id of the resource
      resultCallback - the callback to call with the result

    • getResourceStatus

      void getResourceStatus(CmsUUID structureId, String locale, boolean includeTargets, CmsUUID detailContentId, Map<String,String> context, com.google.gwt.user.client.rpc.AsyncCallback<CmsResourceStatusBean> callback)
      Gets status information for a single resource.

      Parameters:
      structureId - the structure id of the resource
      locale - the locale for which we want the resource information
      includeTargets - flag to control whether relation targets should also be fetched
      detailContentId - the structure id of the detail content if present
      context - a map of context-dependent parameters used to provide additional information
      callback - the callback for the results

    • getRestoreInfo

      void getRestoreInfo(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<CmsRestoreInfoBean> resultCallback)
      Gets the information which is necessary for opening the 'Restore' dialog for a resource.

      Parameters:
      structureId - the structure id of the resource
      resultCallback - the callback for the result

    • getRootEntries

      void getRootEntries(com.google.gwt.user.client.rpc.AsyncCallback<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<String> callback)
      Returns the site-path for the resource with the given id.

      Parameters:
      structureId - the structure id
      callback - the asynchronous callback

    • getSitePaths

      void getSitePaths(List<CmsUUID> ids, com.google.gwt.user.client.rpc.AsyncCallback<List<String>> callback)
      Gets the site paths corresponding to a list of structure ids.

      If for any of the structure ids in the input list the corresponding resource can not be read, it will be skipped.

      Parameters:
      ids - a list of structure ids
      callback - the result callback

    • getStructureId

      void getStructureId(String vfsPath, com.google.gwt.user.client.rpc.AsyncCallback<CmsUUID> callback)
      Gets the structure id for the given site path.
      Parameters:
      vfsPath - a site path
      callback - the callback for the result

    • getUploadFolderInfo

      void getUploadFolderInfo(String path, com.google.gwt.user.client.rpc.AsyncCallback<CmsListInfoBean> callback)
      Gets the resource info to display for an upload folder.
      Parameters:
      path - the folder path
      callback - the callback to call with the result

    • loadLinkInfo

      void loadLinkInfo(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<CmsExternalLinkInfoBean> callback)
      Loads the external link info.

      Parameters:
      structureId - the external link structure id
      callback - the 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

    • loadQuickLaunchItems

      void loadQuickLaunchItems(CmsQuickLaunchParams params, com.google.gwt.user.client.rpc.AsyncCallback<List<CmsQuickLaunchData>> resultCallback)
      Loads the items for the quick launch menu.

      Parameters:
      params - the quick launch parameters
      resultCallback - the callback for the result

    • prepareEdit

      void prepareEdit(CmsUUID currentPage, 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

    • renameResource

      void renameResource(CmsUUID structureId, String newName, com.google.gwt.user.client.rpc.AsyncCallback<String> callback)
      Renames a resource.

      Parameters:
      structureId - the structure id of the resource to rename
      newName - the new resource name
      callback - the asynchronous callback for the result

    • restoreResource

      void restoreResource(CmsUUID structureId, int version, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Restores a previous version of the resource.

      Parameters:
      structureId - the structure id of the version
      version - the number of the version to which the resource should be reverted
      callback - the callback to call with the results

    • saveAliases

      void saveAliases(CmsUUID structureId, List<CmsAliasBean> aliases, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Saves aliases for a page.

      Parameters:
      structureId - the structure id of the page
      aliases - the aliases which should be saved for the page
      callback - the async callback

    • saveExternalLink

      void saveExternalLink(CmsUUID structureId, String title, String link, String fileName, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Saves the external link.

      Parameters:
      structureId - the link structure id
      title - the link title
      link - the link
      fileName - the file name
      callback - the asynchronous callback

    • saveProperties

      void saveProperties(CmsPropertyChangeSet changes, boolean updateIndex, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Saves a set of property changes.

      Parameters:
      changes - the property changes
      updateIndex - true if the index should be updated after saving the property changes
      callback - the asynchronous callback

    • substituteLinkForRootPath

      void substituteLinkForRootPath(String currentSiteRoot, String rootPath, com.google.gwt.user.client.rpc.AsyncCallback<String> callback)
      Returns the absolute link to the given root path.

      Parameters:
      currentSiteRoot - the current site
      rootPath - the root path
      callback - the asynchronous callback

    • syncDeleteResource

      @SynchronizedRpcRequest void syncDeleteResource(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Deletes a resource from the VFS.

      Parameters:
      structureId - the structure id of the resource to delete
      callback - the callback

    • undelete

      void undelete(CmsUUID structureId, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Undeletes a resource.

      Parameters:
      structureId - the structure id of the resource
      callback - the result callback

    • undoChanges

      void undoChanges(CmsUUID structureId, boolean undoMove, com.google.gwt.user.client.rpc.AsyncCallback<Void> callback)
      Undoes the changes to a given resource, i.e. restores its online content to its offline version.

      Parameters:
      structureId - the structure id of the resource to undo
      undoMove - true if move operations should be undone
      callback - the callback for the result

    • validateAliases

      void validateAliases(CmsUUID structureId, Map<String,String> aliasPaths, com.google.gwt.user.client.rpc.AsyncCallback<Map<String,String>> callback)
      Validates alias paths for a page.

      Parameters:
      structureId - the structure id of the page
      aliasPaths - a map from (arbitrary) id strings to alias paths
      callback - the async callback