Interface I_CmsContentService

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DICT_CONTENT_DEFINITION
      The content definition dictionary name.
      static java.lang.String PARAM_BACKLINK
      The back-link parameter.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      CmsContentDefinition callEditorChangeHandlers​(java.lang.String entityId, CmsEntity editedLocaleEntity, java.util.Collection<java.lang.String> skipPaths, java.util.Collection<java.lang.String> changedScopes)
      Calls the editor change handlers.
      void copyLocale​(java.util.Collection<java.lang.String> locales, CmsEntity sourceLocale)
      Copies the given source locale to the target locales.
      CmsContentDefinition loadDefinition​(java.lang.String entityId, java.lang.String clientId, CmsEntity editedLocaleEntity, java.util.Collection<java.lang.String> skipPaths, java.util.Map<java.lang.String,​java.lang.String> settingPresets)
      Loads the content definition for a given entity.
      CmsContentDefinition loadInitialDefinition​(java.lang.String entityId, java.lang.String clientId, java.lang.String newLink, CmsUUID modelFileId, java.lang.String editContext, java.lang.String mainLocale, java.lang.String mode, java.lang.String postCreateHandler, CmsEditHandlerData editHandlerData, java.util.Map<java.lang.String,​java.lang.String> settingPresets)
      Loads the content definition for a given entity.
      CmsContentDefinition loadNewDefinition​(java.lang.String entityId, java.lang.String clientId, CmsEntity editedLocaleEntity, java.util.Collection<java.lang.String> skipPaths, java.util.Map<java.lang.String,​java.lang.String> settingPresets)
      Loads new entity definition.
      CmsContentDefinition prefetch()
      Returns the content definition of the resource requested through parameter 'resource'.
      CmsSaveResult saveAndDeleteEntities​(CmsEntity lastEditedEntity, java.lang.String clientId, java.util.List<java.lang.String> deletedEntities, java.util.Collection<java.lang.String> skipPaths, java.lang.String lastEditedLocale, boolean clearOnSuccess)
      Saves and deletes the given entities.
      java.lang.String saveValue​(java.lang.String contentId, java.lang.String contentPath, java.lang.String locale, java.lang.String value)
      Saves a value in an existing XML content.
    • Method Detail

      • callEditorChangeHandlers

        CmsContentDefinition callEditorChangeHandlers​(java.lang.String entityId,
                                                      CmsEntity editedLocaleEntity,
                                                      java.util.Collection<java.lang.String> skipPaths,
                                                      java.util.Collection<java.lang.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​(java.util.Collection<java.lang.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​(java.lang.String entityId,
                                            java.lang.String clientId,
                                            CmsEntity editedLocaleEntity,
                                            java.util.Collection<java.lang.String> skipPaths,
                                            java.util.Map<java.lang.String,​java.lang.String> settingPresets)
                                     throws java.lang.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:
        java.lang.Exception - if something goes wrong processing the request
      • loadInitialDefinition

        CmsContentDefinition loadInitialDefinition​(java.lang.String entityId,
                                                   java.lang.String clientId,
                                                   java.lang.String newLink,
                                                   CmsUUID modelFileId,
                                                   java.lang.String editContext,
                                                   java.lang.String mainLocale,
                                                   java.lang.String mode,
                                                   java.lang.String postCreateHandler,
                                                   CmsEditHandlerData editHandlerData,
                                                   java.util.Map<java.lang.String,​java.lang.String> settingPresets)
                                            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
        Returns:
        the content definition
        Throws:
        CmsRpcException - if something goes wrong processing the request
      • loadNewDefinition

        CmsContentDefinition loadNewDefinition​(java.lang.String entityId,
                                               java.lang.String clientId,
                                               CmsEntity editedLocaleEntity,
                                               java.util.Collection<java.lang.String> skipPaths,
                                               java.util.Map<java.lang.String,​java.lang.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
      • saveAndDeleteEntities

        CmsSaveResult saveAndDeleteEntities​(CmsEntity lastEditedEntity,
                                            java.lang.String clientId,
                                            java.util.List<java.lang.String> deletedEntities,
                                            java.util.Collection<java.lang.String> skipPaths,
                                            java.lang.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

        java.lang.String saveValue​(java.lang.String contentId,
                                   java.lang.String contentPath,
                                   java.lang.String locale,
                                   java.lang.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