Interface I_CmsContentService

All Superinterfaces:
I_CmsContentService, com.google.gwt.user.client.rpc.RemoteService
All Known Implementing Classes:
CmsContentService

public interface I_CmsContentService extends I_CmsContentService
The content editor service interface.

  • Field Details

  • Method Details

    • callEditorChangeHandlers

      CmsContentDefinition callEditorChangeHandlers(String entityId, CmsEntity editedLocaleEntity, Collection<String> skipPaths, Collection<String> changedScopes) throws CmsRpcException
      Calls the editor change handlers.

      Parameters:
      entityId - the edited entity id
      editedLocaleEntity - the edited entity
      skipPaths - the locale synchronization value paths to skip
      changedScopes - the changed content value paths
      Returns:
      the changed content
      Throws:
      CmsRpcException - in case anything goes wrong
    • copyLocale

      void copyLocale(Collection<String> locales, CmsEntity sourceLocale) throws CmsRpcException
      Copies the given source locale to the target locales.

      Parameters:
      locales - the target locales
      sourceLocale - the source locale
      Throws:
      CmsRpcException - if something goes wrong
    • loadDefinition

      CmsContentDefinition loadDefinition(String entityId, String clientId, CmsEntity editedLocaleEntity, Collection<String> skipPaths, Map<String,String> settingPresets) throws Exception
      Loads the content definition for a given entity.

      Parameters:
      entityId - the entity id/URI
      clientId - the container element client id if available
      editedLocaleEntity - the edited locale entity
      skipPaths - the paths to skip during locale synchronization
      settingPresets - the presets for container element settings
      Returns:
      the content definition
      Throws:
      Exception - if something goes wrong processing the request
    • loadInitialDefinition

      CmsContentDefinition loadInitialDefinition(String entityId, String clientId, String newLink, CmsUUID modelFileId, String editContext, String mainLocale, String mode, String postCreateHandler, CmsEditHandlerData editHandlerData, Map<String,String> settingPresets, String editorStylesheet) throws CmsRpcException
      Loads the content definition for a given entity.

      Parameters:
      entityId - the entity id/URI
      clientId - the container element client id if available
      newLink - the new link
      modelFileId - the optional model file id
      editContext - the container page currently being edited (may be null)
      mainLocale - the main language to copy in case the element language node does not exist yet
      mode - the content creation mode
      postCreateHandler - the post-create handler class name
      editHandlerData - the edit handler data, if an edit handler is used for creating a new element; null otherwise
      settingPresets - the presets for container element settings
      editorStylesheet - the path of the editor style sheet (may be null)
      Returns:
      the content definition
      Throws:
      CmsRpcException - if something goes wrong processing the request
    • loadNewDefinition

      CmsContentDefinition loadNewDefinition(String entityId, String clientId, CmsEntity editedLocaleEntity, Collection<String> skipPaths, Map<String,String> settingPresets) throws CmsRpcException
      Loads new entity definition.

      This will load the entity representation of a new locale node.

      Parameters:
      entityId - the entity id/URI
      clientId - the container element client id if available
      editedLocaleEntity - the edited locale entity
      skipPaths - the paths to skip during locale synchronization
      settingPresets - the presets for container element settings
      Returns:
      the content definition
      Throws:
      CmsRpcException - if something goes wrong processing the request
    • prefetch

      Returns the content definition of the resource requested through parameter 'resource'.

      Returns:
      the content definition
      Throws:
      CmsRpcException - if something goes wrong
    • saveAndDeleteEntities

      CmsSaveResult saveAndDeleteEntities(CmsEntity lastEditedEntity, String clientId, List<String> deletedEntities, Collection<String> skipPaths, String lastEditedLocale, boolean clearOnSuccess) throws CmsRpcException
      Saves and deletes the given entities. Returns the editor save result information.

      Parameters:
      lastEditedEntity - the last edited entity
      clientId - the container element client id if available
      deletedEntities - the entity id's to delete
      skipPaths - the paths to skip during locale synchronization
      lastEditedLocale - the last edited locale
      clearOnSuccess - true to unlock resource after saving
      Returns:
      the editor save result information
      Throws:
      CmsRpcException - if something goes wrong processing the request
    • saveValue

      String saveValue(String contentId, String contentPath, String locale, String value) throws CmsRpcException
      Saves a value in an existing XML content.

      Parameters:
      contentId - the structure id of the content
      contentPath - the xpath of the value to set
      locale - the locale in which to set the value
      value - the value to set
      Returns:
      not used
      Throws:
      CmsRpcException - if something goes wrong