Package org.opencms.gwt.shared.rpc

Interface I_CmsCoreService

All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
All Known Implementing Classes:
CmsCoreService
public interface I_CmsCoreService extends com.google.gwt.user.client.rpc.RemoteService
Provides general core services.

Since:
8.0.0
See Also:

  • Method Details

    • changePassword

      String changePassword(String oldPassword, String newPassword, String newPasswordConfirm) throws CmsRpcException
      Changes the password of the current user.

      Parameters:
      oldPassword - the old password
      newPassword - the value entered for the new password
      newPasswordConfirm - the value entered for the confirmation of the new password
      Returns:
      an error message if an error occurred, or null if the password was successfully changed
      Throws:
      CmsRpcException - if something goes wrong

    • createUUID

      CmsUUID createUUID() throws CmsRpcException
      Creates a new UUID.

      Returns:
      the created UUID
      Throws:
      CmsRpcException - if something goes wrong

    • getBroadcast

      List<CmsBroadcastMessage> getBroadcast() throws CmsRpcException
      Returns the latest messages for the current user.

      Returns:
      the messages
      Throws:
      CmsRpcException - if anything goes wrong

    • getCategories

      List<CmsCategoryTreeEntry> getCategories(String fromCatPath, boolean includeSubCats, String refVfsPath, boolean withRepositories, Set<String> selected) throws CmsRpcException
      Returns the categories for the given search parameters.

      Parameters:
      fromCatPath - the category path to start with, can be null or empty to use the root
      includeSubCats - if to include all categories, or first level child categories only
      refVfsPath - the reference path (site-relative path according to which the available category repositories are determined), can be null to only use the system repository
      withRepositories - flag, indicating if also the category repositories should be returned as category
      selected - a set of paths of currently selected categories (which should be included in the result even if they are marked as hidden)
      Returns:
      the resource categories
      Throws:
      CmsRpcException - if something goes wrong

    • getCategoriesForSitePath

      List<CmsCategoryTreeEntry> getCategoriesForSitePath(String sitePath) throws CmsRpcException
      Returns the categories for the given reference site-path.

      Parameters:
      sitePath - the reference site-path
      Returns:
      the categories for the given reference site-path
      Throws:
      CmsRpcException - if something goes wrong

    • getCategoryInfo

      CmsResourceCategoryInfo getCategoryInfo(CmsUUID structureId) throws CmsRpcException
      Returns the category information for the given resource.

      Parameters:
      structureId - the resource structure id
      Returns:
      the category information
      Throws:
      CmsRpcException - if something goes wrong

    • getContextMenuEntries

      List<CmsContextMenuEntryBean> getContextMenuEntries(CmsUUID structureId, CmsCoreData.AdeContext context) throws CmsRpcException
      Returns the context menu entries for the given URI.

      Parameters:
      structureId - the currently requested structure id
      context - the ade context (sitemap or containerpage)
      Returns:
      the context menu entries
      Throws:
      CmsRpcException - if something goes wrong

    • getContextMenuEntries

      List<CmsContextMenuEntryBean> getContextMenuEntries(CmsUUID structureId, CmsCoreData.AdeContext context, Map<String,String> params) throws CmsRpcException
      Returns the context menu entries for the given URI.

      Parameters:
      structureId - the currently requested structure id
      context - the ade context (sitemap or containerpage)
      params - additional context information the server side can use to determine menu item availability
      Returns:
      the context menu entries
      Throws:
      CmsRpcException - if something goes wrong

    • getLinkForReturnCode

      CmsReturnLinkInfo getLinkForReturnCode(String returnCode) throws CmsRpcException
      Given a return code, returns the link to the page which corresponds to the return code.

      Parameters:
      returnCode - the return code
      Returns:
      the link for the return code
      Throws:
      CmsRpcException - if something goes wrong

    • getResourceState

      CmsResourceState getResourceState(CmsUUID structureId) throws CmsRpcException
      Gets the resource state for a resource with a given path.

      Parameters:
      structureId - the resource structure id
      Returns:
      the resource state of the resource
      Throws:
      CmsRpcException - if something goes wrong

    • getUniqueFileName

      String getUniqueFileName(String parentFolder, String baseName) throws CmsRpcException
      Returns a unique filename for the given base name and the parent folder.

      Parameters:
      parentFolder - the parent folder of the file
      baseName - the proposed file name
      Returns:
      the unique file name
      Throws:
      CmsRpcException - if something goes wrong

    • getUserInfo

      CmsCoreData.UserInfo getUserInfo() throws CmsRpcException
      Returns the user info.

      Returns:
      the user info
      Throws:
      CmsRpcException - in case something goes wrong

    • getWorkplaceLink

      String getWorkplaceLink(CmsUUID structureId) throws CmsRpcException
      Returns a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.

      Parameters:
      structureId - the structure id of the resource for which to open the workplace
      Returns:
      a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.
      Throws:
      CmsRpcException - if something goes wrong

    • getWorkplaceLinkForPath

      String getWorkplaceLinkForPath(String path) throws CmsRpcException
      Gets the workplace link for the given path.
      Parameters:
      path - the path
      Returns:
      the workplace link for the path
      Throws:
      CmsRpcException - if something goes wrong

    • loadUserSettings

      CmsUserSettingsBean loadUserSettings() throws CmsRpcException
      Loads the user settings for the current user.

      Returns:
      the user settings for the current user
      Throws:
      CmsRpcException - if something goes wrong

    • lockIfExists

      String lockIfExists(String sitePath) throws CmsRpcException
      Locks the given resource with a temporary lock if it exists.

      If the resource does not exist yet, the closest existing ancestor folder will check if it is lockable.

      Parameters:
      sitePath - the site path of the resource to lock
      Returns:
      null if successful, an error message if not
      Throws:
      CmsRpcException - if something goes wrong

    • lockIfExists

      String lockIfExists(String sitePath, long loadTime) throws CmsRpcException
      Locks the given resource with a temporary lock if it exists.

      If the resource does not exist yet, the closest existing ancestor folder will check if it is lockable.

      Parameters:
      sitePath - the site path of the resource to lock
      loadTime - the time when the requested resource was loaded
      Returns:
      null if successful, an error message if not
      Throws:
      CmsRpcException - if something goes wrong

    • lockTemp

      String lockTemp(CmsUUID structureId) throws CmsRpcException
      Locks the given resource with a temporary lock.

      Parameters:
      structureId - the structure id of the resource to lock
      Returns:
      null if successful, an error message if not
      Throws:
      CmsRpcException - if something goes wrong

    • lockTemp

      String lockTemp(CmsUUID structureId, long loadTime) throws CmsRpcException
      Locks the given resource with a temporary lock.

      Locking will fail in case the requested resource has been changed since the given load time.

      Parameters:
      structureId - the resource structure id
      loadTime - the time when the requested resource was loaded
      Returns:
      null if successful, an error message if not
      Throws:
      CmsRpcException - if something goes wrong

    • prefetch

      CmsCoreData prefetch() throws CmsRpcException
      Generates core data for prefetching in the host page.

      Returns:
      the core data
      Throws:
      CmsRpcException - if something goes wrong

    • saveUsedCategory

      void saveUsedCategory(String category) throws CmsRpcException
      Saves a category used by the current user.
      Parameters:
      category - the category
      Throws:
      CmsRpcException - if something goes wrong

    • saveUserSettings

      void saveUserSettings(Map<String,String> userSettings, Set<String> edited) throws CmsRpcException
      Saves the user settings for the current user.

      Parameters:
      userSettings - the new values for the user settings
      edited - the keys of the user settings which were actually edited
      Throws:
      CmsRpcException - if something goes wrong

    • setResourceCategories

      void setResourceCategories(CmsUUID structureId, List<String> categories) throws CmsRpcException
      Sets the categories of the given resource. Will remove all other categories.

      Parameters:
      structureId - the resource structure id
      categories - the categories to set
      Throws:
      CmsRpcException - if something goes wrong

    • setShowEditorHelp

      void setShowEditorHelp(boolean showHelp) throws CmsRpcException
      Sets the show editor help flag.

      Parameters:
      showHelp - the show help flag
      Throws:
      CmsRpcException - if something goes wrong

    • setToolbarVisible

      void setToolbarVisible(boolean visible) throws CmsRpcException
      Writes the tool-bar visibility into the session cache.

      Parameters:
      visible - true if the tool-bar is visible
      Throws:
      CmsRpcException - if something goes wrong

    • unlock

      String unlock(CmsUUID structureId) throws CmsRpcException
      Unlocks the given resource.

      Parameters:
      structureId - the structure id of the resource to unlock
      Returns:
      null if successful, an error message if not
      Throws:
      CmsRpcException - if something goes wrong

    • unlock

      String unlock(String rootPath) throws CmsRpcException
      Unlocks the given resource.

      Parameters:
      rootPath - the root path of the resource to unlock
      Returns:
      null if successful, an error message if not
      Throws:
      CmsRpcException - if something goes wrong

    • validate

      Map<String,CmsValidationResult> validate(Map<String,CmsValidationQuery> validationQueries) throws CmsRpcException
      Performs a batch of validations and returns the results.

      Parameters:
      validationQueries - a map from field names to validation queries
      Returns:
      a map from field names to validation results
      Throws:
      CmsRpcException - if something goes wrong

    • validate

      Map<String,CmsValidationResult> validate(String formValidatorClass, Map<String,CmsValidationQuery> validationQueries, Map<String,String> values, String config) throws CmsRpcException
      Performs a batch of validations using a custom form validator class.

      Parameters:
      formValidatorClass - the class name of the form validator
      validationQueries - a map from field names to validation queries
      values - the map of all field values
      config - the form validator configuration string
      Returns:
      a map from field names to validation results
      Throws:
      CmsRpcException - if the RPC call goes wrong