Interface I_CmsSitemapService

    • Method Detail

      • changeCategory

        void changeCategory​(java.lang.String entryPoint,
                            CmsUUID id,
                            java.lang.String title,
                            java.lang.String name)
                     throws CmsRpcException
        Sets the name and title of the given category.

        Parameters:
        entryPoint - the current entry point
        id - the category id
        title - the new title
        name - the new name
        Throws:
        CmsRpcException - if something goes wrong
      • createCategory

        void createCategory​(java.lang.String entryPoint,
                            CmsUUID id,
                            java.lang.String title,
                            java.lang.String name)
                     throws CmsRpcException
        Creates a new category.

        Parameters:
        entryPoint - the entry point
        id - the parent category id
        title - the title
        name - the category name
        Throws:
        CmsRpcException - if something goes wrong
      • createNewGalleryFolder

        CmsGalleryFolderEntry createNewGalleryFolder​(java.lang.String parentFolder,
                                                     java.lang.String title,
                                                     int folderTypeId)
                                              throws CmsRpcException
        Creates a new gallery folder.

        Parameters:
        parentFolder - the parent folder path
        title - the title property
        folderTypeId - the resource type id
        Returns:
        the new gallery folder data
        Throws:
        CmsRpcException - if something goes wrong
      • createNewModelPage

        CmsModelPageEntry createNewModelPage​(java.lang.String entryPointUri,
                                             java.lang.String title,
                                             java.lang.String description,
                                             CmsUUID copyId,
                                             boolean isModelGroup)
                                      throws CmsRpcException
        Creates a new model page.

        Parameters:
        entryPointUri - the uri of the entry point
        title - the title for the model page
        description - the description for the model page
        copyId - the structure id of the resource to copy to create a new model page; if null, the model page is created as an empty container page
        isModelGroup - true to create a new model group page
        Returns:
        a bean representing the created model page
        Throws:
        CmsRpcException - if something goes wrong
      • createSubSitemap

        CmsSitemapChange createSubSitemap​(CmsUUID entryId)
                                   throws CmsRpcException
        Creates a sub-sitemap of the given sitemap starting from the given entry.

        Parameters:
        entryId - the structure id of the sitemap entry to create a sub sitemap of
        Returns:
        the sub-sitemap creation result
        Throws:
        CmsRpcException - if something goes wrong
      • disableModelPage

        void disableModelPage​(java.lang.String baseUri,
                              CmsUUID modelPageId,
                              boolean disabled)
                       throws CmsRpcException
        Sets the disabled flag of a model page within the current sitemap configuration.

        Parameters:
        baseUri - the base uri for the current sitemap
        modelPageId - structure id of the model page to remove
        disabled - the disabled flag
        Throws:
        CmsRpcException - if something goes wrong
      • getAliasImportResult

        java.util.List<CmsAliasImportResultgetAliasImportResult​(java.lang.String resultKey)
                                                           throws CmsRpcException
        Gets the alias import results from the server.

        Parameters:
        resultKey - the key which identifies the alias import results to get
        Returns:
        the list of alias import results
        Throws:
        CmsRpcException - if something goes wrong
      • getChildren

        CmsClientSitemapEntry getChildren​(java.lang.String entryPointUri,
                                          CmsUUID entryId,
                                          int levels)
                                   throws CmsRpcException
        Returns the sitemap children for the given path.

        Parameters:
        entryPointUri - the URI of the sitemap entry point
        entryId - the entry id
        levels - the count of child levels to read
        Returns:
        the sitemap children
        Throws:
        CmsRpcException - if something goes wrong
      • getModelInfos

        CmsModelInfo getModelInfos​(CmsUUID rootId)
                            throws CmsRpcException
        Gets the model pages for the given structure id of the sitemap root folder.

        Parameters:
        rootId - structure id of a folder
        Returns:
        the model pages available in the given folder
        Throws:
        CmsRpcException - if something goes wrong
      • getNewElementInfo

        java.util.List<CmsNewResourceInfogetNewElementInfo​(java.lang.String entryPointUri)
                                                      throws CmsRpcException
        Loads the model page data for the "add" menu.

        Parameters:
        entryPointUri - the entry point uri
        Returns:
        the list of resource info beans for the model pages
        Throws:
        CmsRpcException - if something goes wrong
      • getResourceLink

        java.lang.String getResourceLink​(CmsUUID baseId,
                                         java.lang.String sitePath)
                                  throws CmsRpcException
        Fetches the link for a resource selected in the sitemap editor.

        Parameters:
        baseId - the structure id of the current sitemap root entry
        sitePath - the site path of a resource
        Returns:
        the link to the resource
        Throws:
        CmsRpcException - if something goes wrong
      • mergeSubSitemap

        CmsSitemapChange mergeSubSitemap​(java.lang.String entryPoint,
                                         CmsUUID subSitemapId)
                                  throws CmsRpcException
        Merges a sub-sitemap into it's parent sitemap.

        Parameters:
        entryPoint - the sitemap entry point
        subSitemapId - the structure id of the sub sitemap folder
        Returns:
        the result of the merge operation
        Throws:
        CmsRpcException - if something goes wrong
      • prefetch

        CmsSitemapData prefetch​(java.lang.String sitemapUri)
                         throws CmsRpcException
        Returns the initialization data for the given sitemap.

        Parameters:
        sitemapUri - the site relative path
        Returns:
        the initialization data
        Throws:
        CmsRpcException - if something goes wrong
      • prepareReloadSitemap

        java.lang.String prepareReloadSitemap​(CmsUUID rootId,
                                              CmsSitemapData.EditorMode mode)
                                       throws CmsRpcException
        Prepares sitemap reloading for the given sitemap root.

        This method may change the currently set site root. If the given root id is not in a valid site, null will be returned, otherwise the URL which the client should use to reload the sitemap will be returned.

        Parameters:
        rootId - the structure id of the new sitemap root
        mode - the new editor mode
        Returns:
        the URL which should be used to reload the sitemap
        Throws:
        CmsRpcException - if something goes wrong
      • removeModelPage

        void removeModelPage​(java.lang.String baseUri,
                             CmsUUID modelPageId)
                      throws CmsRpcException
        Removes a model page from the current sitemap configuration.

        Parameters:
        baseUri - the base uri for the current sitemap
        modelPageId - structure id of the model page to remove
        Throws:
        CmsRpcException - if something goes wrong
      • savePropertiesForLocaleCompareMode

        void savePropertiesForLocaleCompareMode​(CmsUUID id,
                                                java.lang.String newUrlName,
                                                java.util.List<CmsPropertyModification> propertyChanges,
                                                boolean editedName)
                                         throws CmsRpcException
        Saves the changed properties in locale comparison mode.

        Parameters:
        id - the structure id
        newUrlName - the new URL name
        propertyChanges - the property changes
        editedName - true if the name was edited
        Throws:
        CmsRpcException - if something goes wrong
      • saveSitemapAttributes

        void saveSitemapAttributes​(CmsUUID rootId,
                                   java.util.Map<java.lang.String,​java.lang.String> attributes)
                            throws CmsRpcException
        Saves the data from the sitemap attribute editor dialog to the sitemap configuration.
        Parameters:
        rootId - the root ID
        attributes - the sitemap attributes
        Throws:
        CmsRpcException - if something goes wrong
      • setDefaultModel

        CmsModelInfo setDefaultModel​(CmsUUID rootId,
                                     CmsUUID modelId)
                              throws CmsRpcException
        Sets the default model page for the given sub-sitemap, returns the updated model info.

        Parameters:
        rootId - structure id of the sub-sitemap root folder
        modelId - the id of the model page to set as default
        Returns:
        the updated model info
        Throws:
        CmsRpcException - if something goes wrong
      • updateAliasEditorStatus

        void updateAliasEditorStatus​(boolean editing)
                              throws CmsRpcException
        Updates the alias editor status.

        This is used to keep two users from editing the alias table for a site root concurrently.

        Parameters:
        editing - true to indicate that the table is still being edited, false to indicate that the table isn't being edited anymore
        Throws:
        CmsRpcException - if something goes wrong