Package org.opencms.ade.sitemap.shared.rpc

Interface I_CmsSitemapService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

CmsVfsSitemapService

public interface I_CmsSitemapService
extends com.google.gwt.user.client.rpc.RemoteService

Handles all RPC services related to the sitemap.

Since:

8.0.0

See Also:

• CmsVfsSitemapService
• I_CmsSitemapService
• I_CmsSitemapServiceAsync

Method Summary

Modifier and Type	Method	Description
void	changeCategory(String entryPoint, CmsUUID id, String title, String name)	Sets the name and title of the given category.
void	createCategory(String entryPoint, CmsUUID id, String title, String name)	Creates a new category.
CmsGalleryFolderEntry	createNewGalleryFolder(String parentFolder, String title, int folderTypeId)	Creates a new gallery folder.
CmsModelPageEntry	createNewModelPage(String entryPointUri, String title, String description, CmsUUID copyId, boolean isModelGroup)	Creates a new model page.
CmsSitemapChange	createSubSitemap(CmsUUID entryId)	Creates a sub-sitemap of the given sitemap starting from the given entry.
void	disableModelPage(String baseUri, CmsUUID modelPageId, boolean disabled)	Sets the disabled flag of a model page within the current sitemap configuration.
CmsSitemapAttributeData	editAttributeData(CmsUUID rootId)	Loads the data for the attribute editor dialog and locks the sitemap configuration.
List<CmsAliasImportResult>	getAliasImportResult(String resultKey)	Gets the alias import results from the server.
CmsAliasInitialFetchResult	getAliasTable()	Gets the initial data for the bulk alias editor.
CmsSitemapCategoryData	getCategoryData(String entryPoint)	Gets the category data for the given entry point.
CmsClientSitemapEntry	getChildren(String entryPointUri, CmsUUID entryId, int levels)	Returns the sitemap children for the given path.
Map<CmsGalleryType,List<CmsGalleryFolderEntry>>	getGalleryData(String entryPointUri)	Returns the gallery data to this sub site.
CmsModelInfo	getModelInfos(CmsUUID rootId)	Gets the model pages for the given structure id of the sitemap root folder.
List<CmsNewResourceInfo>	getNewElementInfo(String entryPointUri)	Loads the model page data for the "add" menu.
String	getResourceLink(CmsUUID baseId, String sitePath)	Fetches the link for a resource selected in the sitemap editor.
CmsLocaleComparePropertyData	loadPropertyDataForLocaleCompareView(CmsUUID id, CmsUUID rootId)	Loads the data needed by the property editor in the locale comparison view.
CmsSitemapChange	mergeSubSitemap(String entryPoint, CmsUUID subSitemapId)	Merges a sub-sitemap into it's parent sitemap.
CmsSitemapData	prefetch(String sitemapUri)	Returns the initialization data for the given sitemap.
String	prepareReloadSitemap(CmsUUID rootId, CmsSitemapData.EditorMode mode)	Prepares sitemap reloading for the given sitemap root.
void	removeModelPage(String baseUri, CmsUUID modelPageId)	Removes a model page from the current sitemap configuration.
CmsSitemapChange	save(String sitemapUri, CmsSitemapChange change)	Saves the change to the given sitemap.
CmsAliasEditValidationReply	saveAliases(CmsAliasSaveValidationRequest saveRequest)	Saves the aliases for the bulk alias editor.
void	savePropertiesForLocaleCompareMode(CmsUUID id, String newUrlName, List<CmsPropertyModification> propertyChanges, boolean editedName)	Saves the changed properties in locale comparison mode.
void	saveSitemapAttributes(CmsUUID rootId, Map<String,String> attributes)	Saves the data from the sitemap attribute editor dialog to the sitemap configuration.
CmsModelInfo	setDefaultModel(CmsUUID rootId, CmsUUID modelId)	Sets the default model page for the given sub-sitemap, returns the updated model info.
void	setEditorMode(CmsSitemapData.EditorMode editorMode)	Sets the editor mode in the current user session.
void	updateAliasEditorStatus(boolean editing)	Updates the alias editor status.
CmsAliasEditValidationReply	validateAliases(CmsAliasEditValidationRequest validationRequest)	Validates the aliases for the bulk alias editor.
CmsRewriteAliasValidationReply	validateRewriteAliases(CmsRewriteAliasValidationRequest validationRequest)	Validates rewrite aliases.

Method Details

changeCategory

void changeCategory(String entryPoint,
 CmsUUID id,
 String title,
 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(String entryPoint,
 CmsUUID id,
 String title,
 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(String parentFolder,
 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(String entryPointUri,
 String title,
 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(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

editAttributeData

CmsSitemapAttributeData editAttributeData(CmsUUID rootId)
                                   throws CmsRpcException

Loads the data for the attribute editor dialog and locks the sitemap configuration.

Parameters:

rootId - the root ID of the current sitemap

Returns:

the data for the attribute editor dialog

Throws:

CmsRpcException - if something goes wrong

getAliasImportResult

List<CmsAliasImportResult> getAliasImportResult(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

getAliasTable

CmsAliasInitialFetchResult getAliasTable()
                                  throws CmsRpcException

Gets the initial data for the bulk alias editor.

Returns:

the initial data for the alias editor

Throws:

CmsRpcException - if something goes wrong

getCategoryData

CmsSitemapCategoryData getCategoryData(String entryPoint)
                                throws CmsRpcException

Gets the category data for the given entry point.

Parameters:

entryPoint - the entry point

Returns:

the category data

Throws:

CmsRpcException - if something goes wrong

getChildren

CmsClientSitemapEntry getChildren(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

getGalleryData

Map<CmsGalleryType,List<CmsGalleryFolderEntry>> getGalleryData(String entryPointUri)
                                                        throws CmsRpcException

Returns the gallery data to this sub site.

Parameters:

entryPointUri - the sub site folder

Returns:

the gallery data to this sub site

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

List<CmsNewResourceInfo> getNewElementInfo(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

String getResourceLink(CmsUUID baseId,
 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

loadPropertyDataForLocaleCompareView

CmsLocaleComparePropertyData loadPropertyDataForLocaleCompareView(CmsUUID id,
 CmsUUID rootId)
                                                           throws CmsRpcException

Loads the data needed by the property editor in the locale comparison view.

Parameters:

id - the id of the resource for which the property editor should be opened

rootId - the structure id of the resource which corresponds to the tree root in locale compare mode

Returns:

the property data for locale comparison mode

Throws:

CmsRpcException - if something goes wrong

mergeSubSitemap

CmsSitemapChange mergeSubSitemap(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(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

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

save

CmsSitemapChange save(String sitemapUri,
 CmsSitemapChange change)
               throws CmsRpcException

Saves the change to the given sitemap.

Parameters:

sitemapUri - the sitemap URI

change - the change to save

Returns:

the updated change

Throws:

CmsRpcException - if something goes wrong

saveAliases

CmsAliasEditValidationReply saveAliases(CmsAliasSaveValidationRequest saveRequest)
                                 throws CmsRpcException

Saves the aliases for the bulk alias editor.

Parameters:

saveRequest - the object containing the data to save

Returns:

the result of saving the aliases

Throws:

CmsRpcException - if something goes wrong

savePropertiesForLocaleCompareMode

void savePropertiesForLocaleCompareMode(CmsUUID id,
 String newUrlName,
 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,
 Map<String,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

setEditorMode

void setEditorMode(CmsSitemapData.EditorMode editorMode)
            throws CmsRpcException

Sets the editor mode in the current user session.

Parameters:

editorMode - the editor mode to set

Throws:

CmsRpcException - in case 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

validateAliases

CmsAliasEditValidationReply validateAliases(CmsAliasEditValidationRequest validationRequest)
                                     throws CmsRpcException

Validates the aliases for the bulk alias editor.

Parameters:

validationRequest - an object indicating the type of validation to perform

Returns:

the validation result

Throws:

CmsRpcException - if something goes wrong

validateRewriteAliases

CmsRewriteAliasValidationReply validateRewriteAliases(CmsRewriteAliasValidationRequest validationRequest)
                                               throws CmsRpcException

Validates rewrite aliases.

Parameters:

validationRequest - the rewrite alias data to validate

Returns:

the validation result

Throws:

CmsRpcException - if something goes wrong